Update github.io docs to use static website instead of blobs directly (…

…Azure#9652) * Update github.io docs to use static website instead of blobs directly * Update eng/common/scripts/copy-docs-to-blobstorage.ps1 Co-authored-by: Ben Broderick Phillips <[email protected]> * Switch from AzurePowerShell to AzureCLI task * Add scriptLocation to docindex.yml * Update Generate-DocIndex.ps1 * Fix indentation in docindex.yml script block --------- Co-authored-by: Ben Broderick Phillips <[email protected]>
swathipil · Feb 4, 2025 · 5d8073b · 5d8073b
1 parent 50e5f68
commit 5d8073b
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 15 deletions.
diff --git a/eng/common/docgeneration/Generate-DocIndex.ps1 b/eng/common/docgeneration/Generate-DocIndex.ps1
@@ -25,13 +25,14 @@ function Get-BlobStorage-Artifacts(
     # "--query '[].name'" returns a list of only blob names
     # "--num-results *" handles pagination so the caller does not have to
     $artifacts = az storage blob list `
+        --auth-mode login `
         --account-name $storageAccountName `
         --container-name $storageContainerName `
         --prefix $storagePrefix `
         --delimiter / `
         --only-show-errors `
         --query '[].name' `
-        --num-results * | ConvertFrom-Json
+        --num-results * | ConvertFrom-Json 
     LogDebug "Number of artifacts found: $($artifacts.Length)"
 
     # example: "python/azure-storage-blob" -> "azure-storage-blob"

diff --git a/eng/common/docgeneration/templates/matthews/styles/main.js b/eng/common/docgeneration/templates/matthews/styles/main.js
@@ -108,7 +108,7 @@ function httpGetAsyncFallbackOnFail(targetUrl, successCallback, failureCallback)
 }
 
 function populateOptions(selector, packageName) {
-    var versionRequestUrl = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions"
+    var versionRequestUrl = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions"
 
     httpGetAsync(versionRequestUrl, function (responseText) {
         var versionselector = document.createElement("select")
@@ -181,9 +181,9 @@ function loadedOtherVersions(url, latestVersions, publishedVersions, selector, c
 }
 
 function populateIndexList(selector, packageName) {
-    var url = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions"
-    var latestGAUrl = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-ga"
-    var latestPreviewUrl = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-preview"
+    var url = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions"
+    var latestGAUrl = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-ga"
+    var latestPreviewUrl = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-preview"
     var latestVersions = document.createElement("ul")
     httpGetLatestAsync(latestGAUrl, latestVersions, packageName)
     httpGetLatestAsync(latestPreviewUrl, latestVersions, packageName)
@@ -217,7 +217,7 @@ function populateIndexList(selector, packageName) {
 }
 
 function getPackageUrl(language, package, version) {
-    return "https://azuresdkdocs.blob.core.windows.net/$web/" + language + "/" + package + "/" + version + "/index.html"
+    return "https://azuresdkdocs.z19.web.core.windows.net/" + language + "/" + package + "/" + version + "/index.html"
 }
 
 // Populate Versions

diff --git a/eng/common/pipelines/templates/jobs/docindex.yml b/eng/common/pipelines/templates/jobs/docindex.yml
@@ -15,12 +15,14 @@ jobs:
         workingDirectory: $(Build.BinariesDirectory)
         displayName: Download and Extract DocFX
 
-      - task: PowerShell@2
+      - task: AzureCLI@2
         displayName: 'Generate Doc Index'
         inputs:
-          pwsh: true
-          filePath: $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1 
-          arguments: >
+          azureSubscription: 'Azure SDK Artifacts'
+          scriptType: pscore
+          scriptLocation: inlineScript
+          inlineScript: >
+            $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1
             -Docfx $(docfxPath)
             -RepoRoot $(Build.SourcesDirectory)
             -DocGenDir "$(Build.SourcesDirectory)/eng/common/docgeneration"

diff --git a/eng/common/scripts/copy-docs-to-blobstorage.ps1 b/eng/common/scripts/copy-docs-to-blobstorage.ps1
@@ -116,7 +116,7 @@ function Get-Existing-Versions
     Param (
         [Parameter(Mandatory=$true)] [String]$PkgName
     )
-    $versionUri = "${BlobAccountName}/`$web/$($Language)/$($PkgName)/versioning/versions"
+    $versionUri = "https://azuresdkdocs.z19.web.core.windows.net/$Language/$PkgName/versioning/versions"
     LogDebug "Heading to $versionUri to retrieve known versions"
 
     try {

diff --git a/packages/python-packages/apiview-gpt/guidelines/python/design.json b/packages/python-packages/apiview-gpt/guidelines/python/design.json
@@ -47,7 +47,7 @@
   {
     "id": "python_design.html#python-client-constructor-transport-argument",
     "category": "Client configuration",
-    "text": "DO allow users to pass in a transport keyword-only argument that allows the caller to specify a specific transport instance. The default value should be the RequestsTransport (https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/1.1.1/azure.core.pipeline.transport.html?highlight=transport#azure.core.pipeline.transport.RequestsTransport) for synchronous clients and the AioHttpTransport (https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/1.1.1/azure.core.pipeline.transport.html?highlight=transport#azure.core.pipeline.transport.AioHttpTransport) for async clients."
+    "text": "DO allow users to pass in a transport keyword-only argument that allows the caller to specify a specific transport instance. The default value should be the RequestsTransport (https://azuresdkdocs.z19.web.core.windows.net/python/azure-core/1.1.1/azure.core.pipeline.transport.html?highlight=transport#azure.core.pipeline.transport.RequestsTransport) for synchronous clients and the AioHttpTransport (https://azuresdkdocs.z19.web.core.windows.net/python/azure-core/1.1.1/azure.core.pipeline.transport.html?highlight=transport#azure.core.pipeline.transport.AioHttpTransport) for async clients."
   },
   {
     "id": "python_design.html#python-client-connection-string",
@@ -282,7 +282,7 @@
   {
     "id": "python_design.html#python-errors-azure-exceptions",
     "category": "Exceptions",
-    "text": "YOU SHOULD prefer raising existing exception types from the azure-core (https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/1.9.0/index.html#azure-core-library-exceptions) package over creating new exception types."
+    "text": "YOU SHOULD prefer raising existing exception types from the azure-core (https://azuresdkdocs.z19.web.core.windows.net/python/azure-core/1.9.0/index.html#azure-core-library-exceptions) package over creating new exception types."
   },
   {
     "id": "python_design.html#python-errors-use-standard-exceptions",
@@ -292,7 +292,7 @@
   {
     "id": "python_design.html#python-errors-new-exceptions",
     "category": "Exceptions",
-    "text": "YOU SHOULD NOT create a new exception type unless the developer can handle the error programmatically.  Specialized exception types related to service operation failures should be based on existing exception types from the azure-core (https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/1.9.0/index.html#azure-core-library-exceptions) package.\n\nFor higher-level methods that use multiple HTTP requests, either the last exception or an aggregate exception of all failures should be produced."
+    "text": "YOU SHOULD NOT create a new exception type unless the developer can handle the error programmatically.  Specialized exception types related to service operation failures should be based on existing exception types from the azure-core (https://azuresdkdocs.z19.web.core.windows.net/python/azure-core/1.9.0/index.html#azure-core-library-exceptions) package.\n\nFor higher-level methods that use multiple HTTP requests, either the last exception or an aggregate exception of all failures should be produced."
   },
   {
     "id": "python_design.html#python-errors-rich-info",

diff --git a/packages/python-packages/apiview-gpt/guidelines/python/implementation.json b/packages/python-packages/apiview-gpt/guidelines/python/implementation.json
@@ -22,7 +22,7 @@
   {
     "id": "python_implementation.html#python-custom-policy-base-class",
     "category": "Custom policies",
-    "text": "DO derive from HTTPPolicy (https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/1.9.0/azure.core.pipeline.policies.html#azure.core.pipeline.policies.HTTPPolicy) AsyncHTTPPolicy (https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/1.9.0/azure.core.pipeline.policies.html#azure.core.pipeline.policies.AsyncHTTPPolicy) (if you need to make network calls) or SansIOHTTPPolicy (https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/1.9.0/azure.core.pipeline.policies.html#azure.core.pipeline.policies.SansIOHTTPPolicy) (if you do not)."
+    "text": "DO derive from HTTPPolicy (https://azuresdkdocs.z19.web.core.windows.net/python/azure-core/1.9.0/azure.core.pipeline.policies.html#azure.core.pipeline.policies.HTTPPolicy) AsyncHTTPPolicy (https://azuresdkdocs.z19.web.core.windows.net/python/azure-core/1.9.0/azure.core.pipeline.policies.html#azure.core.pipeline.policies.AsyncHTTPPolicy) (if you need to make network calls) or SansIOHTTPPolicy (https://azuresdkdocs.z19.web.core.windows.net/python/azure-core/1.9.0/azure.core.pipeline.policies.html#azure.core.pipeline.policies.SansIOHTTPPolicy) (if you do not)."
   },
   {
     "id": "python_implementation.html#python-custom-policy-thread-safe",