From 72b82dfadfcd0d83f45443a9f3a1d7182f692e9a Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Fri, 24 Feb 2023 16:05:41 +0100 Subject: [PATCH 1/5] microsite: Add redirect for /docs Signed-off-by: Johan Haals --- docs/README.md | 3 --- microsite-next/docusaurus.config.js | 11 +++++++++++ microsite-next/package.json | 1 + microsite-next/yarn.lock | 21 +++++++++++++++++++++ 4 files changed, 33 insertions(+), 3 deletions(-) delete mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index c63a12b589..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Documentation - -The Backstage documentation is available at https://backstage.io/docs diff --git a/microsite-next/docusaurus.config.js b/microsite-next/docusaurus.config.js index c3956bb308..b3d1d16af1 100644 --- a/microsite-next/docusaurus.config.js +++ b/microsite-next/docusaurus.config.js @@ -96,6 +96,17 @@ module.exports = { }; }, }), + [ + '@docusaurus/plugin-client-redirects', + { + redirects: [ + { + from: '/docs', + to: '/docs/overview/what-is-backstage', + }, + ], + }, + ], ], themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ diff --git a/microsite-next/package.json b/microsite-next/package.json index c223e87584..cb71d5a25a 100644 --- a/microsite-next/package.json +++ b/microsite-next/package.json @@ -30,6 +30,7 @@ "prettier": "@spotify/prettier-config", "dependencies": { "@docusaurus/core": "2.3.1", + "@docusaurus/plugin-client-redirects": "^2.3.1", "@docusaurus/preset-classic": "2.3.1", "@swc/core": "^1.3.36", "clsx": "^1.1.1", diff --git a/microsite-next/yarn.lock b/microsite-next/yarn.lock index d633230dd6..517e3c2280 100644 --- a/microsite-next/yarn.lock +++ b/microsite-next/yarn.lock @@ -1813,6 +1813,26 @@ __metadata: languageName: node linkType: hard +"@docusaurus/plugin-client-redirects@npm:^2.3.1": + version: 2.3.1 + resolution: "@docusaurus/plugin-client-redirects@npm:2.3.1" + dependencies: + "@docusaurus/core": 2.3.1 + "@docusaurus/logger": 2.3.1 + "@docusaurus/utils": 2.3.1 + "@docusaurus/utils-common": 2.3.1 + "@docusaurus/utils-validation": 2.3.1 + eta: ^2.0.0 + fs-extra: ^10.1.0 + lodash: ^4.17.21 + tslib: ^2.4.0 + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + checksum: bb730359c7f9015108a3d4ec8a570e9c73847349747bf71711f522a7dc40007786b7cd25cebc845eeb16b3505e8068242559a2eda790f4c07d4083d9014a6f84 + languageName: node + linkType: hard + "@docusaurus/plugin-content-blog@npm:2.3.1": version: 2.3.1 resolution: "@docusaurus/plugin-content-blog@npm:2.3.1" @@ -3708,6 +3728,7 @@ __metadata: dependencies: "@docusaurus/core": 2.3.1 "@docusaurus/module-type-aliases": 2.3.1 + "@docusaurus/plugin-client-redirects": ^2.3.1 "@docusaurus/preset-classic": 2.3.1 "@spotify/prettier-config": ^14.0.0 "@swc/core": ^1.3.36 From 3c38b7cd4d18a4f5711ad716188e1e10d724f47a Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 27 Feb 2023 10:07:05 +0100 Subject: [PATCH 2/5] Update link to docs Signed-off-by: Johan Haals --- docs/openapi/definitions/auth.yaml | 2 +- packages/backend-app-api/README.md | 2 +- packages/backend-common/README.md | 2 +- packages/backend-defaults/README.md | 2 +- packages/backend-dev-utils/README.md | 2 +- packages/backend-plugin-api/README.md | 2 +- packages/backend-tasks/README.md | 2 +- packages/backend-test-utils/README.md | 2 +- packages/backend/README.md | 2 +- packages/cli-common/README.md | 2 +- packages/cli/README.md | 2 +- packages/codemods/README.md | 2 +- packages/config-loader/README.md | 2 +- packages/config/README.md | 2 +- .../create-app/templates/default-app/packages/backend/README.md | 2 +- packages/dev-utils/README.md | 2 +- packages/e2e-test/README.md | 2 +- packages/test-utils/README.md | 2 +- packages/theme/README.md | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/openapi/definitions/auth.yaml b/docs/openapi/definitions/auth.yaml index 863544c71a..1ed649da9c 100644 --- a/docs/openapi/definitions/auth.yaml +++ b/docs/openapi/definitions/auth.yaml @@ -19,7 +19,7 @@ info: version: 0.1.1-alpha.8 externalDocs: description: Backstage official documentation - url: https://github.com/backstage/backstage/blob/master/docs/README.md + url: https://backstage.io/docs servers: - url: http://localhost:7007/api/auth/ tags: diff --git a/packages/backend-app-api/README.md b/packages/backend-app-api/README.md index 44705cde52..e5b80abeaf 100644 --- a/packages/backend-app-api/README.md +++ b/packages/backend-app-api/README.md @@ -16,5 +16,5 @@ yarn add --cwd packages/backend @backstage/backend-app-api ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) - [Backstage Backend System](https://backstage.io/docs/backend-system/) diff --git a/packages/backend-common/README.md b/packages/backend-common/README.md index a1ebf18841..578fbc0830 100644 --- a/packages/backend-common/README.md +++ b/packages/backend-common/README.md @@ -36,4 +36,4 @@ app.listen(PORT, () => { ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/backend-defaults/README.md b/packages/backend-defaults/README.md index 826994da23..2dcc5766df 100644 --- a/packages/backend-defaults/README.md +++ b/packages/backend-defaults/README.md @@ -16,5 +16,5 @@ yarn add --cwd packages/backend @backstage/backend-defaults ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) - [Backstage Backend System](https://backstage.io/docs/backend-system/) diff --git a/packages/backend-dev-utils/README.md b/packages/backend-dev-utils/README.md index c60f5a4ad7..cebe591d50 100644 --- a/packages/backend-dev-utils/README.md +++ b/packages/backend-dev-utils/README.md @@ -16,5 +16,5 @@ yarn add --cwd plugins/-backend @backstage/backend-dev-utils ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) - [Backstage Backend System](https://backstage.io/docs/backend-system/) diff --git a/packages/backend-plugin-api/README.md b/packages/backend-plugin-api/README.md index 02b19a0c40..a17c8715a7 100644 --- a/packages/backend-plugin-api/README.md +++ b/packages/backend-plugin-api/README.md @@ -16,5 +16,5 @@ yarn add --cwd plugins/-backend @backstage/backend-plugin-api ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) - [Backstage Backend System](https://backstage.io/docs/backend-system/) diff --git a/packages/backend-tasks/README.md b/packages/backend-tasks/README.md index b3c304eb34..afaca06e55 100644 --- a/packages/backend-tasks/README.md +++ b/packages/backend-tasks/README.md @@ -35,4 +35,4 @@ When working with the `@backstage/backend-tasks` library you may run into your t ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/backend-test-utils/README.md b/packages/backend-test-utils/README.md index 7ccf4e2798..d0f52388bb 100644 --- a/packages/backend-test-utils/README.md +++ b/packages/backend-test-utils/README.md @@ -15,4 +15,4 @@ yarn add --dev @backstage/backend-test-utils ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/backend/README.md b/packages/backend/README.md index e4fd81749d..f86d09842a 100644 --- a/packages/backend/README.md +++ b/packages/backend/README.md @@ -58,4 +58,4 @@ Read more about the [auth-backend](https://github.com/backstage/backstage/blob/m ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/cli-common/README.md b/packages/cli-common/README.md index 91b774145e..e16398e81a 100644 --- a/packages/cli-common/README.md +++ b/packages/cli-common/README.md @@ -9,4 +9,4 @@ Do not install this package directly, it is an internal package used by [@backst ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/cli/README.md b/packages/cli/README.md index 1aa4233032..2b0db93cea 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -25,4 +25,4 @@ To try out the command locally, you can execute the following from the parent di ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/codemods/README.md b/packages/codemods/README.md index c40e9a8dcc..791612c06b 100644 --- a/packages/codemods/README.md +++ b/packages/codemods/README.md @@ -35,4 +35,4 @@ npx jscodeshift --parser=tsx --extensions=tsx,js,ts,tsx --transform=node_modules ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/config-loader/README.md b/packages/config-loader/README.md index 261394a6a5..ccb792404d 100644 --- a/packages/config-loader/README.md +++ b/packages/config-loader/README.md @@ -9,4 +9,4 @@ Do not install this package directly, it is an internal package used by [@backst ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/config/README.md b/packages/config/README.md index 9866b1bce9..4c130ef6a3 100644 --- a/packages/config/README.md +++ b/packages/config/README.md @@ -9,4 +9,4 @@ Do not install this package directly, it is an internal package used by [@backst ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/create-app/templates/default-app/packages/backend/README.md b/packages/create-app/templates/default-app/packages/backend/README.md index aa042db030..867487ba0a 100644 --- a/packages/create-app/templates/default-app/packages/backend/README.md +++ b/packages/create-app/templates/default-app/packages/backend/README.md @@ -56,4 +56,4 @@ and ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/dev-utils/README.md b/packages/dev-utils/README.md index 78fa3bf7f6..9f71ef1b03 100644 --- a/packages/dev-utils/README.md +++ b/packages/dev-utils/README.md @@ -16,4 +16,4 @@ yarn add -D @backstage/dev-utils ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/e2e-test/README.md b/packages/e2e-test/README.md index f3692de2a7..19f37a600e 100644 --- a/packages/e2e-test/README.md +++ b/packages/e2e-test/README.md @@ -21,4 +21,4 @@ If you make changes to other packages you will need to rerun `yarn tsc && yarn b ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/test-utils/README.md b/packages/test-utils/README.md index d32ebcaf02..74e6d823d3 100644 --- a/packages/test-utils/README.md +++ b/packages/test-utils/README.md @@ -14,4 +14,4 @@ yarn add -D @backstage/test-utils ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) diff --git a/packages/theme/README.md b/packages/theme/README.md index 0dc4059745..f50ed1cea6 100644 --- a/packages/theme/README.md +++ b/packages/theme/README.md @@ -14,4 +14,4 @@ yarn add @backstage/theme ## Documentation - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md) -- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md) +- [Backstage Documentation](https://backstage.io/docs) From 482dae5de1c10cb86fb45b0895a41f159a8f9402 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 27 Feb 2023 10:21:28 +0100 Subject: [PATCH 3/5] Add changeset Signed-off-by: Johan Haals --- .changeset/twelve-cars-push.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .changeset/twelve-cars-push.md diff --git a/.changeset/twelve-cars-push.md b/.changeset/twelve-cars-push.md new file mode 100644 index 0000000000..632688c933 --- /dev/null +++ b/.changeset/twelve-cars-push.md @@ -0,0 +1,19 @@ +--- +'@backstage/backend-plugin-api': patch +'@backstage/backend-test-utils': patch +'@backstage/backend-dev-utils': patch +'@backstage/backend-defaults': patch +'@backstage/backend-app-api': patch +'@backstage/backend-common': patch +'@backstage/backend-tasks': patch +'@backstage/config-loader': patch +'@backstage/cli-common': patch +'@backstage/create-app': patch +'@backstage/test-utils': patch +'@backstage/dev-utils': patch +'@backstage/codemods': patch +'@backstage/config': patch +'@backstage/theme': patch +--- + +Updated link to docs. From 1545e3293ed7a8f76470d9ffc971052d75035c6d Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 27 Feb 2023 13:41:58 +0100 Subject: [PATCH 4/5] remove redundant link Signed-off-by: Johan Haals --- docs/plugins/structure-of-a-plugin.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/plugins/structure-of-a-plugin.md b/docs/plugins/structure-of-a-plugin.md index c71b27b448..8bf21bf589 100644 --- a/docs/plugins/structure-of-a-plugin.md +++ b/docs/plugins/structure-of-a-plugin.md @@ -117,5 +117,3 @@ backend-side authorization. To smooth this process out you can use proxy - either the one you already have (like Nginx, HAProxy, etc.) or the proxy-backend plugin that we provide for the Backstage backend. [Read more](https://github.com/backstage/backstage/blob/master/plugins/proxy-backend/README.md) - -[Back to Getting Started](../README.md) From ab229c55f21ede3a8820ebd3db871b9ddb863658 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 27 Feb 2023 13:55:50 +0100 Subject: [PATCH 5/5] add patch changeset for cli Signed-off-by: Johan Haals --- .changeset/twelve-cars-push.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.changeset/twelve-cars-push.md b/.changeset/twelve-cars-push.md index 632688c933..599d456d2b 100644 --- a/.changeset/twelve-cars-push.md +++ b/.changeset/twelve-cars-push.md @@ -14,6 +14,7 @@ '@backstage/codemods': patch '@backstage/config': patch '@backstage/theme': patch +'@backstage/cli': patch --- Updated link to docs.