Merge pull request #4520 from microsoft/octogonz/api-links

octogonz · web-flow · commit 1e053bcb91e0 · 2024-02-16T19:23:39.000-08:00
Fix broken API links in README.md files
diff --git a/apps/api-documenter/README.md b/apps/api-documenter/README.md
@@ -14,6 +14,6 @@ documentation.
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/apps/api-documenter/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/api-documenter/)
+- [API Reference](https://api.rushstack.io/pages/api-documenter/)
 
 API Documenter is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/apps/api-extractor/README.md b/apps/api-extractor/README.md
@@ -46,6 +46,6 @@ For more details and support resources, please visit: https://api-extractor.com/
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/apps/api-extractor/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/api-extractor/)
+- [API Reference](https://api.rushstack.io/pages/api-extractor/)
 
 API Extractor is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/apps/heft/README.md b/apps/heft/README.md
@@ -85,6 +85,6 @@ the Rush Stack website.
 - [UPGRADING.md](
   https://github.com/microsoft/rushstack/blob/main/apps/heft/UPGRADING.md) - Instructions
   for migrating existing projects to use a newer version of Heft
-- [API Reference](https://rushstack.io/pages/api/heft/)
+- [API Reference](https://api.rushstack.io/pages/heft/)
 
 Heft is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/build-tests/ts-command-line-test/README.md b/build-tests/ts-command-line-test/README.md
@@ -131,7 +131,7 @@ Console Title: Default title
 Arguments to be executed: ["1","2","3"]
 ```
 
-For more about environment variables, see the [IBaseCommandLineDefinition.environmentVariable](https://rushstack.io/pages/api/ts-command-line.ibasecommandlinedefinition.environmentvariable/) documentation.
+For more about environment variables, see the [IBaseCommandLineDefinition.environmentVariable](https://api.rushstack.io/pages/ts-command-line.ibasecommandlinedefinition.environmentvariable/) documentation.
 
 ## More information
 
diff --git a/common/changes/@microsoft/api-documenter/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@microsoft/api-documenter/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@microsoft/api-documenter"
+    }
+  ],
+  "packageName": "@microsoft/api-documenter",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@microsoft/api-extractor-model/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@microsoft/api-extractor-model/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@microsoft/api-extractor-model"
+    }
+  ],
+  "packageName": "@microsoft/api-extractor-model",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@microsoft/api-extractor/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@microsoft/api-extractor/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@microsoft/api-extractor"
+    }
+  ],
+  "packageName": "@microsoft/api-extractor",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/debug-certificate-manager/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/debug-certificate-manager/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/debug-certificate-manager"
+    }
+  ],
+  "packageName": "@rushstack/debug-certificate-manager",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/eslint-plugin/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/eslint-plugin/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/eslint-plugin"
+    }
+  ],
+  "packageName": "@rushstack/eslint-plugin",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/heft-config-file/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/heft-config-file/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/heft-config-file"
+    }
+  ],
+  "packageName": "@rushstack/heft-config-file",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/heft/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/heft/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/heft"
+    }
+  ],
+  "packageName": "@rushstack/heft",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/module-minifier/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/module-minifier/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/module-minifier"
+    }
+  ],
+  "packageName": "@rushstack/module-minifier",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/node-core-library/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/node-core-library/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/node-core-library"
+    }
+  ],
+  "packageName": "@rushstack/node-core-library",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/operation-graph/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/operation-graph/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/operation-graph"
+    }
+  ],
+  "packageName": "@rushstack/operation-graph",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/package-deps-hash/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/package-deps-hash/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/package-deps-hash"
+    }
+  ],
+  "packageName": "@rushstack/package-deps-hash",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/package-extractor/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/package-extractor/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/package-extractor"
+    }
+  ],
+  "packageName": "@rushstack/package-extractor",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/rig-package/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/rig-package/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/rig-package"
+    }
+  ],
+  "packageName": "@rushstack/rig-package",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/stream-collator/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/stream-collator/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/stream-collator"
+    }
+  ],
+  "packageName": "@rushstack/stream-collator",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/terminal/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/terminal/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/terminal"
+    }
+  ],
+  "packageName": "@rushstack/terminal",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/tree-pattern/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/tree-pattern/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/tree-pattern"
+    }
+  ],
+  "packageName": "@rushstack/tree-pattern",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/ts-command-line/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/ts-command-line/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/ts-command-line"
+    }
+  ],
+  "packageName": "@rushstack/ts-command-line",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/typings-generator/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/typings-generator/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/typings-generator"
+    }
+  ],
+  "packageName": "@rushstack/typings-generator",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/worker-pool/octogonz-api-links_2024-02-17-03-00.json b/common/changes/@rushstack/worker-pool/octogonz-api-links_2024-02-17-03-00.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix broken link to API documentation",
+      "type": "patch",
+      "packageName": "@rushstack/worker-pool"
+    }
+  ],
+  "packageName": "@rushstack/worker-pool",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}
diff --git a/eslint/eslint-plugin/README.md b/eslint/eslint-plugin/README.md
@@ -81,7 +81,7 @@ If you are designing a new JSON file format, it's a good idea to avoid `null` en
 there are better representations that convey more information about an item that is unknown, omitted,
 or disabled.  If you do need to declare types for JSON structures containing `null`, rather than
 suppressing the lint rule, you can use a specialized
-[JsonNull](https://rushstack.io/pages/api/node-core-library.jsonnull/)
+[JsonNull](https://api.rushstack.io/pages/node-core-library.jsonnull/)
 type as provided by [@rushstack/node-core-library](https://www.npmjs.com/package/@rushstack/node-core-library).
 
 
diff --git a/libraries/api-extractor-model/README.md b/libraries/api-extractor-model/README.md
@@ -4,7 +4,7 @@ Use this library to read and write *.api.json files as defined by the [API Extra
 These files are used to generate a documentation website for your TypeScript package.  The files store the
 API signatures and doc comments that were extracted from your package.
 
-API documentation for this package: https://rushstack.io/pages/api/api-extractor-model/
+API documentation for this package: https://api.rushstack.io/pages/api-extractor-model/
 
 ## Example Usage
 
@@ -63,6 +63,6 @@ a namespace containing static members of the class.
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/api-extractor-model/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/api-extractor-model/)
+- [API Reference](https://api.rushstack.io/pages/api-extractor-model/)
 
 API Extractor is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/debug-certificate-manager/README.md b/libraries/debug-certificate-manager/README.md
@@ -45,6 +45,6 @@ Attempts to locate a previously generated debug certificate and untrust it. Retu
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/debug-certificate-manager/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/debug-certificate-manager/)
+- [API Reference](https://api.rushstack.io/pages/debug-certificate-manager/)
 
 **@rushstack/debug-certificate-manager** is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/heft-config-file/README.md b/libraries/heft-config-file/README.md
@@ -7,6 +7,6 @@ A library for loading config files for use with the [Heft](https://rushstack.io/
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/heft-config-file/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/heft-config-file/)
+- [API Reference](https://api.rushstack.io/pages/heft-config-file/)
 
 Heft is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/module-minifier/README.md b/libraries/module-minifier/README.md
@@ -7,6 +7,6 @@ This library wraps terser in convenient handles for parallelization. It powers @
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/module-minifier/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/module-minifier/)
+- [API Reference](https://api.rushstack.io/pages/module-minifier/)
 
 `@rushstack/module-minifier` is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/node-core-library/README.md b/libraries/node-core-library/README.md
@@ -33,6 +33,6 @@ demonstrated.  If in doubt, create your own NPM package.
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/node-core-library/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/node-core-library/)
+- [API Reference](https://api.rushstack.io/pages/node-core-library/)
 
 `@rushstack/node-core-library` is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/operation-graph/README.md b/libraries/operation-graph/README.md
@@ -7,6 +7,6 @@ This library contains logic for managing and executing tasks in a directed acycl
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/operation-graph/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/operation-graph/)
+- [API Reference](https://api.rushstack.io/pages/operation-graph/)
 
 `@rushstack/operation-graph` is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/package-deps-hash/README.md b/libraries/package-deps-hash/README.md
@@ -34,6 +34,6 @@ if (_.isEqual(deps, existingDeps)) {
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/package-deps-hash/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/package-deps-hash/)
+- [API Reference](https://api.rushstack.io/pages/package-deps-hash/)
 
 `@rushstack/package-deps-hash` is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/package-extractor/README.md b/libraries/package-extractor/README.md
@@ -7,6 +7,6 @@ A library used for creating an isolated copy of a package and, optionally, bundl
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/deploy-manager/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/deploy-manager/)
+- [API Reference](https://api.rushstack.io/pages/deploy-manager/)
 
 `@rushstack/package-extractor` is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/rig-package/README.md b/libraries/rig-package/README.md
@@ -224,6 +224,6 @@ Note that there are also async variants of the functions that access the filesys
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/rig-package/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/rig-package/)
+- [API Reference](https://api.rushstack.io/pages/rig-package/)
 
 `@rushstack/rig-package` is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/stream-collator/README.md b/libraries/stream-collator/README.md
@@ -52,6 +52,6 @@ all background streams which have been completed will be emitted.
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/stream-collator/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/stream-collator/)
+- [API Reference](https://api.rushstack.io/pages/stream-collator/)
 
 `@rushstack/stream-collator` is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/terminal/README.md b/libraries/terminal/README.md
@@ -48,6 +48,6 @@ capable of matching substrings that span multiple chunks.
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/terminal/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/terminal/)
+- [API Reference](https://api.rushstack.io/pages/terminal/)
 
 `@rushstack/terminal` is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/tree-pattern/README.md b/libraries/tree-pattern/README.md
@@ -143,6 +143,6 @@ separate patterns.
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/libraries/tree-pattern/CHANGELOG.md) - Find
   out what's new in the latest version
-- [API Reference](https://rushstack.io/pages/api/tree-pattern/)
+- [API Reference](https://api.rushstack.io/pages/tree-pattern/)
 
 `@rushstack/tree-pattern` is part of the [Rush Stack](https://rushstack.io/) family of projects.
diff --git a/libraries/ts-command-line/README.md b/libraries/ts-command-line/README.md
diff --git a/libraries/typings-generator/README.md b/libraries/typings-generator/README.md
diff --git a/libraries/worker-pool/README.md b/libraries/worker-pool/README.md
