Skip to content

Sync eng/common directory with azure-sdk-tools for PR 3000 #3485

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

Merged
azure-sdk merged 19 commits into from
Apr 13, 2022
Merged

Sync eng/common directory with azure-sdk-tools for PR 3000 #3485

Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
f9f93a5
Sort by client, mgmt, track2, track1
sima-zhu Mar 29, 2022
aed12db
sort by the type
sima-zhu Mar 29, 2022
1245e2a
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Mar 30, 2022
f69c809
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Mar 30, 2022
c618b6f
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Mar 30, 2022
050e68f
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Mar 30, 2022
c1ac60e
fix the sorting
sima-zhu Mar 30, 2022
5650d0c
Define the order of new and type
sima-zhu Apr 1, 2022
1532ba6
address comments
sima-zhu Apr 1, 2022
be0bdfb
fix typo
sima-zhu Apr 1, 2022
e1714a8
Address your comments
sima-zhu Apr 4, 2022
f82631a
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Apr 11, 2022
84f338b
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Apr 11, 2022
a2fa4c9
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Apr 11, 2022
61dd093
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Apr 12, 2022
51b31f9
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Apr 12, 2022
fdb5b85
Update Generate-DocIndex.ps1
sima-zhu Apr 12, 2022
bb1abb0
Update Generate-DocIndex.ps1
sima-zhu Apr 12, 2022
cdfc481
Update eng/common/docgeneration/Generate-DocIndex.ps1
sima-zhu Apr 12, 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
29 changes: 21 additions & 8 deletions eng/common/docgeneration/Generate-DocIndex.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ function Get-TocMapping {

foreach ($artifact in $artifacts) {
$packageInfo = $metadata | ? { $_.Package -eq $artifact -and $_.Hide -ne "true" }

$serviceName = ""
$displayName = ""
if (!$packageInfo) {
LogDebug "There is no service name for artifact $artifact or it is marked as hidden. Please check csv of Azure/azure-sdk/_data/release/latest repo if this is intended. "
continue
Expand All @@ -76,16 +76,28 @@ function Get-TocMapping {
LogWarning "There is no service name for artifact $artifact. Please check csv of Azure/azure-sdk/_data/release/latest repo if this is intended. "
# If no service name retrieved, print out warning message, and put it into Other page.
$serviceName = "Other"
$displayName = $packageInfo[0].DisplayName.Trim()
}
else {
if ($packageInfo.Length -gt 1) {
LogWarning "There are more than 1 packages fetched out for artifact $artifact. Please check csv of Azure/azure-sdk/_data/release/latest repo if this is intended. "
}
$serviceName = $packageInfo[0].ServiceName.Trim()
$displayName = $packageInfo[0].DisplayName.Trim()
}
$orderServiceMapping[$artifact] = @($serviceName, $displayName)

# Define the order of "New", "Type", if not match, return the length of the array.
$CustomOrder_New = "true", "false", ""
$newIndex = $CustomOrder_New.IndexOf($packageInfo[0].New.ToLower())
$newIndex = $newIndex -eq -1 ? $CustomOrder_New.Count : $newIndex
$CustomOrder_Type = "client", "mgmt", "compat", "spring", ""
$typeIndex = $CustomOrder_Type.IndexOf($packageInfo[0].Type.ToLower())
$typeIndex = $typeIndex -eq -1 ? $CustomOrder_Type.Count : $typeIndex
$orderServiceMapping[$artifact] = [PSCustomObject][ordered]@{
NewIndex = $newIndex
TypeIndex = $typeIndex
ServiceName = $serviceName
DisplayName = $packageInfo[0].DisplayName.Trim()
Artifact = $artifact
}
}
return $orderServiceMapping
}
Expand Down Expand Up @@ -114,10 +126,11 @@ 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.
foreach ($serviceMapping in ($tocContent.GetEnumerator() | Sort-Object Value, Key)) {
$artifact = $serviceMapping.Key
$serviceName = $serviceMapping.Value[0]
$displayName = $serviceMapping.Value[1]
$sortedToc = $tocContent.Values | Sort-Object NewIndex, TypeIndex, ServiceName, DisplayName, Artifact
foreach ($serviceMapping in $sortedToc) {
$artifact = $serviceMapping.Artifact
$serviceName = $serviceMapping.ServiceName
$displayName = $serviceMapping.DisplayName

# handle spaces in service name, EG "Confidential Ledger"
# handle / in service name, EG "Database for MySQL/PostgreSQL". Leaving a "/" present will generate a bad link location.
Expand Down