Skip to content
Merged
Changes from 11 commits
Commits
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
38 changes: 31 additions & 7 deletions eng/common/docgeneration/Generate-DocIndex.ps1
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,33 @@ 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 = if ($CustomOrder_New.IndexOf($packageInfo[0].New.ToLower()) -eq -1) {
$CustomOrder_New.Count
} else {
$CustomOrder_New.IndexOf($packageInfo[0].New.ToLower())
}
Comment thread
sima-zhu marked this conversation as resolved.
Outdated
$CustomOrder_Type = "client", "mgmt", "compat", "spring", ""
$typeIndex = if ($CustomOrder_Type.IndexOf($packageInfo[0].Type.ToLower()) -eq -1) {
$CustomOrder_Type.Count
} else {
$CustomOrder_Type.IndexOf($packageInfo[0].Type.ToLower())
}
Comment thread
sima-zhu marked this conversation as resolved.
Outdated
$orderServiceMapping[$artifact] = [PSCustomObject][ordered]@{
NewIndex = $newIndex
TypeIndex = $typeIndex
ServiceName = $serviceName
DisplayName = $packageInfo[0].DisplayName.Trim()
}
Comment thread
sima-zhu marked this conversation as resolved.
Comment thread
sima-zhu marked this conversation as resolved.
}
return $orderServiceMapping
}
Expand Down Expand Up @@ -114,10 +131,17 @@ 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)) {
# Track 2 packages go first, then others.
$sortedToc = $tocContent.GetEnumerator() | Sort-Object {
$_.Value.NewIndex,
$_.Value.TypeIndex,
$_.Value.ServiceName,
$_.Value.DisplayName,
$_.Key}
Comment thread
sima-zhu marked this conversation as resolved.
Outdated
foreach ($serviceMapping in $sortedToc) {
$artifact = $serviceMapping.Key
Comment thread
sima-zhu marked this conversation as resolved.
Outdated
$serviceName = $serviceMapping.Value[0]
$displayName = $serviceMapping.Value[1]
$serviceName = $serviceMapping.Value.ServiceName
$displayName = $serviceMapping.Value.DisplayName
Comment thread
sima-zhu marked this conversation as resolved.
Outdated

# 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