From c2a8656e0fa1470f2eda2f16b09b2e3c459ab0c5 Mon Sep 17 00:00:00 2001
From: Daniel Jurek <djurek@microsoft.com>
Date: Fri, 15 Nov 2024 13:43:32 -0800
Subject: [PATCH] Workaround to enable OpenAI documentation on
 learn.microsoft.com (#31788)

Work item to undo the workaround when proper support is implemented in
`type2docfx`: https://github.com/Azure/azure-sdk-for-js/issues/31787

Docs with changes in place:
https://review.learn.microsoft.com/en-us/javascript/api/overview/azure/openai-readme?view=azure-node-preview&branch=djurek%2Fopenai-readme

The change in `Docs-Toc.ps1` adds the OpenAI entry and then sorts the
packages in Cognitive Services so that OpenAI ends up in the right
place.
---
 eng/scripts/docs/Docs-ToC.ps1 | 30 ++++++++++++++++++++++++------
 sdk/openai/ci.yml             |  6 +++++-
 2 files changed, 29 insertions(+), 7 deletions(-)

diff --git a/eng/scripts/docs/Docs-ToC.ps1 b/eng/scripts/docs/Docs-ToC.ps1
index 9387bd6b510..90b94e54897 100644
--- a/eng/scripts/docs/Docs-ToC.ps1
+++ b/eng/scripts/docs/Docs-ToC.ps1
@@ -1,9 +1,9 @@
-function GetOnboardingFile($docRepoLocation, $moniker) { 
+function GetOnboardingFile($docRepoLocation, $moniker) {
   $packageOnboardingFile = "$docRepoLocation/ci-configs/packages-latest.json"
   if ("preview" -eq $moniker) {
     $packageOnboardingFile = "$docRepoLocation/ci-configs/packages-preview.json"
   }
-  elseif ("legacy" -eq $moniker) { 
+  elseif ("legacy" -eq $moniker) {
     $packageOnboardingFile = "$docRepoLocation/ci-configs/packages-legacy.json"
   }
 
@@ -36,7 +36,7 @@ function Get-javascript-OnboardedDocsMsPackagesForMoniker($DocRepoLocation, $mon
   $packageOnboardingFile = GetOnboardingFile `
     -docRepoLocation $DocRepoLocation `
     -moniker $moniker
-  
+
   $onboardedPackages = @{}
   $onboardingSpec = ConvertFrom-Json (Get-Content $packageOnboardingFile -Raw)
   foreach ($spec in $onboardingSpec.npm_package_sources) {
@@ -46,7 +46,7 @@ function Get-javascript-OnboardedDocsMsPackagesForMoniker($DocRepoLocation, $mon
       # Package has an '@' symbol deliminting the end of the package name
       $packageName = $packageName.Substring(0, $packageName.LastIndexOf('@'))
     }
-    
+
     $jsStylePkgName = $packageName.Replace("@", "").Replace("/", "-")
     $jsonFile = "$DocRepoLocation/metadata/$moniker/$jsStylePkgName.json"
     if (Test-Path $jsonFile) {
@@ -66,11 +66,11 @@ function GetPackageReadmeName($packageMetadata) {
   if ($packageMetadata.PSObject.Members.Name -contains "FileMetadata") {
     $readmeMetadata = &$GetDocsMsMetadataForPackageFn -PackageInfo $packageMetadata.FileMetadata
 
-    # Packages released outside of our EngSys will have an empty string for 
+    # Packages released outside of our EngSys will have an empty string for
     # DirectoryPath which will result in an empty string for DocsMsReadMeName.
     # In those cases, do not return the empty name and instead use the fallback
     # logic below.
-    if ($readmeMetadata.DocsMsReadMeName) { 
+    if ($readmeMetadata.DocsMsReadMeName) {
       return $readmeMetadata.DocsMsReadMeName
     }
   }
@@ -110,6 +110,8 @@ function Get-javascript-RepositoryLink ($packageInfo) {
   return "$PackageRepositoryUri/$($packageInfo.Package)"
 }
 
+# Defined in common.ps1 as:
+# $UpdateDocsMsTocFn = "Get-${Language}-UpdatedDocsMsToc"
 function Get-javascript-UpdatedDocsMsToc($toc) {
   $services = $toc[0].items
   for ($i = 0; $i -lt $services.Count; $i++) {
@@ -135,6 +137,22 @@ function Get-javascript-UpdatedDocsMsToc($toc) {
         )
       }
     }
+
+    if ($services[$i].name -eq 'Cognitive Services') {
+      # Add OpenAI to the ToC for Cognitive Services
+      $services[$i].items += [PSCustomObject]@{
+        name = "OpenAI";
+        href = "~/docs-ref-services/{moniker}/openai-readme.md";
+      }
+
+      # Sort the items in the Cognitive Services ToC so OpenAI ends up in the
+      # correct place. The "Management" item should always be at the end of the
+      # list.
+      $management = $services[$i].items | Where-Object { $_.name -eq 'Management' }
+      $sortedItems = $services[$i].items | Where-Object { $_.name -ne 'Management' } | Sort-Object -Property name
+
+      $services[$i].items = $sortedItems + $management
+    }
   }
 
   # PowerShell outputs a single object if the output is an array with only one
diff --git a/sdk/openai/ci.yml b/sdk/openai/ci.yml
index 2c5614e994c..c3bc120fa4b 100644
--- a/sdk/openai/ci.yml
+++ b/sdk/openai/ci.yml
@@ -1,5 +1,5 @@
 # NOTE: Please refer to https://aka.ms/azsdk/engsys/ci-yaml before editing this file.
-                
+
 trigger:
   branches:
     include:
@@ -27,3 +27,7 @@ extends:
     Artifacts:
       - name: azure-openai
         safeName: azureopenai
+        # Disable publishing to learn.microsoft.com until support is added
+        # to type2docfx tooling for this kind of package layout
+        # https://github.com/Azure/azure-sdk-for-js/issues/31787
+        skipPublishDocMs: true