From 5c405fa72fe45a1f398e49e9e5fb946b64ba5334 Mon Sep 17 00:00:00 2001 From: Jack Hsu Date: Thu, 5 Jun 2025 14:16:53 -0400 Subject: [PATCH] docs(misc): add missing angular-rspack and angular-rsbuild API docs and add missing redirects (#31473) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR fixes some 404s in the production nx.dev docs. These were picked up by the script provided here: https://linear.app/nxdev/issue/NXC-2628/create-a-test-for-verifying-the-redirect-rules ``` https://nx.dev/nx-api → Status: 404 https://nx.dev/nx-api/azure-cache/documents/overview → Status: 404 https://nx.dev/nx-api/owners/documents/overview → Status: 404 https://nx.dev/nx-api/gcs-cache/documents/overview → Status: 404 https://nx.dev/nx-api/s3-cache/documents/overview → Status: 404 https://nx.dev/nx-api/shared-fs-cache/documents/overview → Status: 404 https://nx.dev/nx-api/angular-rspack/documents/create-config → Status: 404 https://nx.dev/nx-api/angular-rspack/documents/create-server → Status: 404 https://nx.dev/nx-api/angular-rsbuild/documents/create-config → Status: 404 https://nx.dev/nx-api/angular-rsbuild/documents/create-server → Status: 404 https://nx.dev/nx-api/angular-rspack/documents → Status: 404 https://nx.dev/nx-api/angular-rsbuild/documents → Status: 404 https://nx.dev/nx-api/angular-rspack/executors → Status: 404 https://nx.dev/nx-api/angular-rsbuild/executors → Status: 404 https://nx.dev/nx-api/angular-rspack → Status: 404 https://nx.dev/nx-api/angular-rsbuild → Status: 404 https://nx.dev/nx-api/angular-rspack/migrations → Status: 404 https://nx.dev/nx-api/angular-rsbuild/migrations → Status: 404 https://nx.dev/nx-api/angular-rspack/generators → Status: 404 https://nx.dev/nx-api/angular-rsbuild/generators → Status: 404 ``` **Changes:** - The `/nx-api` goes to `/plugin-registry` since the intend is to list out plugins. - Remote Cache and Owners do not have overview API doc since this is now a proper overview page (e.g. `/reference/core-api/azure-cache/overview` NOT `/reference/core-api/azure-cache/api/documents/overview` - Angular Rspack and Rsbuild had missing API docs that did not get ported --- docs/generated/manifests/menus.json | 38 +++- docs/generated/manifests/nx.json | 260 ++++++++++++++++++++++++++-- docs/generated/manifests/tags.json | 32 ++++ docs/map.json | 30 +++- docs/shared/reference/sitemap.md | 4 + nx-dev/nx-dev/redirect-rules.js | 39 +++++ 6 files changed, 383 insertions(+), 20 deletions(-) diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index 7d2961f7f8..550bbd3742 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -1690,7 +1690,24 @@ "path": "/technologies/angular/angular-rspack/api", "id": "api", "isExternal": false, - "children": [], + "children": [ + { + "name": "Create Config", + "path": "/technologies/angular/angular-rspack/api/create-config", + "id": "create-config", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Create Server", + "path": "/technologies/angular/angular-rspack/api/create-server", + "id": "create-server", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], "disableCollapsible": false } ], @@ -1707,7 +1724,24 @@ "path": "/technologies/angular/angular-rsbuild/api", "id": "api", "isExternal": false, - "children": [], + "children": [ + { + "name": "Create Config", + "path": "/technologies/angular/angular-rsbuild/api/create-config", + "id": "create-config", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, + { + "name": "Create Server", + "path": "/technologies/angular/angular-rsbuild/api/create-server", + "id": "create-server", + "isExternal": false, + "children": [], + "disableCollapsible": false + } + ], "disableCollapsible": false } ], diff --git a/docs/generated/manifests/nx.json b/docs/generated/manifests/nx.json index a2be9ff5a9..be6eeb7ce0 100644 --- a/docs/generated/manifests/nx.json +++ b/docs/generated/manifests/nx.json @@ -3667,8 +3667,31 @@ "name": "API", "description": "", "mediaImage": "", - "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", - "itemList": [], + "file": "", + "itemList": [ + { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-config", + "tags": ["create-config"] + }, + { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-server", + "tags": ["create-server"] + } + ], "isExternal": false, "path": "/technologies/angular/angular-rspack/api", "tags": [] @@ -3690,8 +3713,31 @@ "name": "API", "description": "", "mediaImage": "", - "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", - "itemList": [], + "file": "", + "itemList": [ + { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-config", + "tags": ["create-config"] + }, + { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-server", + "tags": ["create-server"] + } + ], "isExternal": false, "path": "/technologies/angular/angular-rsbuild/api", "tags": [] @@ -5876,8 +5922,31 @@ "name": "API", "description": "", "mediaImage": "", - "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", - "itemList": [], + "file": "", + "itemList": [ + { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-config", + "tags": ["create-config"] + }, + { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-server", + "tags": ["create-server"] + } + ], "isExternal": false, "path": "/technologies/angular/angular-rspack/api", "tags": [] @@ -5899,8 +5968,31 @@ "name": "API", "description": "", "mediaImage": "", - "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", - "itemList": [], + "file": "", + "itemList": [ + { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-config", + "tags": ["create-config"] + }, + { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-server", + "tags": ["create-server"] + } + ], "isExternal": false, "path": "/technologies/angular/angular-rsbuild/api", "tags": [] @@ -6260,8 +6352,31 @@ "name": "API", "description": "", "mediaImage": "", - "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", - "itemList": [], + "file": "", + "itemList": [ + { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-config", + "tags": ["create-config"] + }, + { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-server", + "tags": ["create-server"] + } + ], "isExternal": false, "path": "/technologies/angular/angular-rspack/api", "tags": [] @@ -6387,12 +6502,57 @@ "name": "API", "description": "", "mediaImage": "", - "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", - "itemList": [], + "file": "", + "itemList": [ + { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-config", + "tags": ["create-config"] + }, + { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-server", + "tags": ["create-server"] + } + ], "isExternal": false, "path": "/technologies/angular/angular-rspack/api", "tags": [] }, + "/technologies/angular/angular-rspack/api/create-config": { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-config", + "tags": ["create-config"] + }, + "/technologies/angular/angular-rspack/api/create-server": { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rspack/api/create-server", + "tags": ["create-server"] + }, "/technologies/angular/angular-rsbuild": { "id": "angular-rsbuild", "name": "Angular Rsbuild", @@ -6405,8 +6565,31 @@ "name": "API", "description": "", "mediaImage": "", - "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", - "itemList": [], + "file": "", + "itemList": [ + { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-config", + "tags": ["create-config"] + }, + { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-server", + "tags": ["create-server"] + } + ], "isExternal": false, "path": "/technologies/angular/angular-rsbuild/api", "tags": [] @@ -6421,12 +6604,57 @@ "name": "API", "description": "", "mediaImage": "", - "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", - "itemList": [], + "file": "", + "itemList": [ + { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-config", + "tags": ["create-config"] + }, + { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-server", + "tags": ["create-server"] + } + ], "isExternal": false, "path": "/technologies/angular/angular-rsbuild/api", "tags": [] }, + "/technologies/angular/angular-rsbuild/api/create-config": { + "id": "create-config", + "name": "Create Config", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-config", + "tags": ["create-config"] + }, + "/technologies/angular/angular-rsbuild/api/create-server": { + "id": "create-server", + "name": "Create Server", + "description": "", + "mediaImage": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-server", + "itemList": [], + "isExternal": false, + "path": "/technologies/angular/angular-rsbuild/api/create-server", + "tags": ["create-server"] + }, "/technologies/react": { "id": "react", "name": "React", diff --git a/docs/generated/manifests/tags.json b/docs/generated/manifests/tags.json index b5749165b8..cd547c83eb 100644 --- a/docs/generated/manifests/tags.json +++ b/docs/generated/manifests/tags.json @@ -1177,6 +1177,38 @@ "path": "/technologies/angular/angular-rspack/recipes/internationalization" } ], + "create-config": [ + { + "description": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config", + "id": "create-config", + "name": "Create Config", + "path": "/technologies/angular/angular-rspack/api/create-config" + }, + { + "description": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config", + "id": "create-config", + "name": "Create Config", + "path": "/technologies/angular/angular-rsbuild/api/create-config" + } + ], + "create-server": [ + { + "description": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-server", + "id": "create-server", + "name": "Create Server", + "path": "/technologies/angular/angular-rspack/api/create-server" + }, + { + "description": "", + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-server", + "id": "create-server", + "name": "Create Server", + "path": "/technologies/angular/angular-rsbuild/api/create-server" + } + ], "react": [ { "description": "", diff --git a/docs/map.json b/docs/map.json index f00f7606ce..34dc94b72b 100644 --- a/docs/map.json +++ b/docs/map.json @@ -889,7 +889,20 @@ { "name": "API", "id": "api", - "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config" + "itemList": [ + { + "name": "Create Config", + "id": "create-config", + "tags": ["create-config"], + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-config" + }, + { + "name": "Create Server", + "id": "create-server", + "tags": ["create-server"], + "file": "shared/guides/angular-rspack/api/nx-angular-rspack/create-server" + } + ] } ] }, @@ -900,7 +913,20 @@ { "name": "API", "id": "api", - "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config" + "itemList": [ + { + "name": "Create Config", + "id": "create-config", + "tags": ["create-config"], + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-config" + }, + { + "name": "Create Server", + "id": "create-server", + "tags": ["create-server"], + "file": "shared/guides/angular-rspack/api/nx-angular-rsbuild/create-server" + } + ] } ] } diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index 2d0ef2b416..c034cdd01d 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -203,8 +203,12 @@ - [Handling Configurations](/technologies/angular/angular-rspack/recipes/handling-configurations) - [Internationalization (i18n)](/technologies/angular/angular-rspack/recipes/internationalization) - [API](/technologies/angular/angular-rspack/api) + - [Create Config](/technologies/angular/angular-rspack/api/create-config) + - [Create Server](/technologies/angular/angular-rspack/api/create-server) - [Angular Rsbuild](/technologies/angular/angular-rsbuild) - [API](/technologies/angular/angular-rsbuild/api) + - [Create Config](/technologies/angular/angular-rsbuild/api/create-config) + - [Create Server](/technologies/angular/angular-rsbuild/api/create-server) - [React](/technologies/react) - [Introduction](/technologies/react/introduction) - [Guides](/technologies/react/recipes) diff --git a/nx-dev/nx-dev/redirect-rules.js b/nx-dev/nx-dev/redirect-rules.js index 733604669b..743b86d62f 100644 --- a/nx-dev/nx-dev/redirect-rules.js +++ b/nx-dev/nx-dev/redirect-rules.js @@ -1233,7 +1233,18 @@ const tmpTerminalUiRedirects = { }; const nxApiRedirects = { + // Old index page lists official plugins, so redirect to plugin registry + '/nx-api': '/plugin-registry', // Reference + '/nx-api/azure-cache/documents/overview': + '/reference/core-api/azure-cache/overview', + '/nx-api/owners/documents/overview': '/reference/core-api/owners/overview', + '/nx-api/gcs-cache/documents/overview': + '/reference/core-api/gcs-cache/overview', + '/nx-api/s3-cache/documents/overview': + '/reference/core-api/s3-cache/overview', + '/nx-api/shared-fs-cache/documents/overview': + '/reference/core-api/shared-fs-cache/overview', '/nx-api/devkit/:slug*': '/reference/core-api/devkit/:slug*', '/nx-api/nx/:slug*': '/reference/core-api/nx/:slug*', '/nx-api/workspace/:slug*': '/reference/core-api/workspace/:slug*', @@ -1256,6 +1267,34 @@ const nxApiRedirects = { '/nx-api/create-nx-workspace/documents': '/reference/core-api', '/nx-api/create-nx-workspace/:slug*': '/reference/core-api/create-nx-workspace/:slug*', + // Angular Rspack and Rsbuild -- these never had executors, generators, or migrations + // We'll just redirect them to the API index, and make sure create-server and create-config exist + '/nx-api/angular-rspack/documents/create-config': + '/technologies/angular/angular-rspack/api/create-config', + '/nx-api/angular-rspack/documents/create-server': + '/technologies/angular/angular-rspack/api/create-server', + '/nx-api/angular-rsbuild/documents/create-config': + '/technologies/angular/angular-rsbuild/api/create-config', + '/nx-api/angular-rsbuild/documents/create-server': + '/technologies/angular/angular-rsbuild/api/create-server', + '/nx-api/angular-rspack/documents': + '/technologies/angular/angular-rspack/introduction', + '/nx-api/angular-rsbuild/documents': + '/technologies/angular/angular-rsbuild/api', + '/nx-api/angular-rspack/executors': + '/technologies/angular/angular-rspack/api', + '/nx-api/angular-rsbuild/executors': + '/technologies/angular/angular-rsbuild/api', + '/nx-api/angular-rspack': '/technologies/angular/angular-rspack/introduction', + '/nx-api/angular-rsbuild': '/technologies/angular/angular-rsbuild/api', + '/nx-api/angular-rspack/migrations': + '/technologies/angular/angular-rspack/api', + '/nx-api/angular-rsbuild/migrations': + '/technologies/angular/angular-rsbuild/api', + '/nx-api/angular-rspack/generators': + '/technologies/angular/angular-rspack/api', + '/nx-api/angular-rsbuild/generators': + '/technologies/angular/angular-rsbuild/api', // Technologies '/nx-api/angular/documents/overview': '/technologies/angular/introduction', '/nx-api/react/documents/overview': '/technologies/react/introduction',