From c56ef4be0b52b3beb50e8b9d12b8dbdd8f5802d4 Mon Sep 17 00:00:00 2001 From: Bevan Arps Date: Fri, 18 Oct 2024 16:23:56 +1300 Subject: [PATCH] Upgrade version of docsy and address broken links (#4350) * Additional exclusion * Update version of docsy * Fix links --- docs/hugo/.htmltest.yml | 1 + docs/hugo/content/contributing/developer-setup.md | 8 ++++---- docs/hugo/go.mod | 5 ++++- docs/hugo/go.sum | 8 ++++++++ 4 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/hugo/.htmltest.yml b/docs/hugo/.htmltest.yml index 6469584cd75..a6e9d2ee5c5 100644 --- a/docs/hugo/.htmltest.yml +++ b/docs/hugo/.htmltest.yml @@ -17,5 +17,6 @@ IgnoreURLs: - "https://armwiki.azurewebsites.net/api_contracts/guidelines/templatedeployment.html" # Returns 404 even though valid - "https://marketplace.visualstudio.com/items" # Marketplace links return 401 even if valid - "https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md" # Manually checked, not a 404 + - "https://code.visualstudio.com/docs/devcontainers/containers" # Returns 403 even though valid - "azure-workload-identity" # TODO: Work out why this fails LogLevel: 3 diff --git a/docs/hugo/content/contributing/developer-setup.md b/docs/hugo/content/contributing/developer-setup.md index 80ca0ef970d..8d7c8c40a03 100644 --- a/docs/hugo/content/contributing/developer-setup.md +++ b/docs/hugo/content/contributing/developer-setup.md @@ -22,9 +22,9 @@ Each of these is described in a different section below. See also the [troublesh Use these steps if you've checked out the ASO code into a Linux environment (_including_ WSL 2 on Windows). We've found this to be the best performing option. -The ASO repository contains a [devcontainer](https://code.visualstudio.com/docs/remote/containers) configuration that can be used in conjunction with VS Code to set up an environment with all the required tools preinstalled. +The ASO repository contains a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) configuration that can be used in conjunction with VS Code to set up an environment with all the required tools preinstalled. -0. Make sure you have installed [the prerequisites to use Docker](https://code.visualstudio.com/docs/remote/containers#_system-requirements), including [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) if on Windows. +0. Make sure you have installed [the prerequisites to use Docker](https://code.visualstudio.com/docs/devcontainers/containers#_system-requirements), including [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) if on Windows. 1. Install VS Code and the [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) extension (check installation instructions there). 2. Ensure you have ASO checked out, and that your [repo is healthy](#troubleshooting-repo-health). 3. Open VS Code by running `code .` from the root folder of the ASO repo. @@ -37,9 +37,9 @@ The ASO repository contains a [devcontainer](https://code.visualstudio.com/docs/ If you're working on Windows and _**not**_ using WSL 2, this is the recommended setup. -The ASO repository contains a [devcontainer](https://code.visualstudio.com/docs/remote/containers) configuration that can be used in conjunction with VS Code to set up an environment with all the required tools preinstalled. +The ASO repository contains a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) configuration that can be used in conjunction with VS Code to set up an environment with all the required tools preinstalled. -0. Make sure you have installed [the prerequisites to use Docker](https://code.visualstudio.com/docs/remote/containers#_system-requirements), including [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) if on Windows. +0. Make sure you have installed [the prerequisites to use Docker](https://code.visualstudio.com/docs/devcontainers/containers#_system-requirements), including [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) if on Windows. 1. Install VS Code and the [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) extension (check installation instructions there). 2. Open VS Code 3. Run the VS Code command (with `Ctrl-Shift-P`): `Dev Containers: Clone Repository in Container Volume...` diff --git a/docs/hugo/go.mod b/docs/hugo/go.mod index 86b1be368ce..51721c6e631 100644 --- a/docs/hugo/go.mod +++ b/docs/hugo/go.mod @@ -2,4 +2,7 @@ module github.com/azure/azure-service-operator/docs/hugo go 1.20 -require github.com/google/docsy v0.6.0 // indirect +require ( + github.com/google/docsy v0.10.0 // indirect + github.com/google/docsy/dependencies v0.7.2 // indirect +) diff --git a/docs/hugo/go.sum b/docs/hugo/go.sum index 785c595dcaa..73cbd96ffc5 100644 --- a/docs/hugo/go.sum +++ b/docs/hugo/go.sum @@ -1,5 +1,13 @@ github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/FortAwesome/Font-Awesome v0.0.0-20240402185447-c0f460dca7f7/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= +github.com/google/docsy v0.10.0 h1:6tMDacPwAyRWNCfvsn/9qGOZDQ8b0aRzjRZvnZPY5dg= +github.com/google/docsy v0.10.0/go.mod h1:c0nIAqmRTOuJ01F85U/wJPQtc3Zj9N58Kea9bOT2AJc= github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= +github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI= +github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=