Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sort by service name first #3160

Merged
2 commits merged into from
Apr 19, 2022
Merged

Sort by service name first #3160

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b690876
Sort by service name first
sima-zhu Apr 18, 2022
c5ca32c
Merge branch 'main' of https://github.com/Azure/azure-sdk-tools into …
sima-zhu Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion eng/common/docgeneration/Generate-DocIndex.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ function GenerateDocfxTocContent([Hashtable]$tocContent, [String]$lang, [String]
New-Item -Path $YmlPath -Name "toc.yml" -Force
$visitedService = @{}
# Sort and display toc service name by alphabetical order, and then sort artifact by order.
$sortedToc = $tocContent.Values | Sort-Object NewIndex, TypeIndex, ServiceName, DisplayName, Artifact
$sortedToc = $tocContent.Values | Sort-Object ServiceName, NewIndex, TypeIndex, DisplayName, Artifact
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this only used by the ToC? Where does the sorting for the package list on a given page happen?

Copy link
Contributor Author

@sima-zhu sima-zhu Apr 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our workflow is like,
Loop package in the defined order:
If we first meet the service,

  1. Create {service}.md and put the package info into toc.yml
  2. Then put the service entry into toc.yml.
    If the service visited before,
  3. Add content to {service}.md
    So we have to sort the service to have service sorted in toc.yml first, then in each {service}.md we sort by track 2, client type and display name.

foreach ($serviceMapping in $sortedToc) {
$artifact = $serviceMapping.Artifact
$serviceName = $serviceMapping.ServiceName
Expand Down