paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 44 Packages Projects Releases Wiki Activity

Merge pull request #16593 from backstage/jhaals/docs-redirect

Browse Source 
microsite: Add redirect for /docs
This commit is contained in:
Johan Haals
2023-02-27 15:00:45 +01:00
committed by GitHub
parent 79a45e154a ab229c55f2
commit 10cb6b8e8f
25 changed files with 72 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/twelve-cars-push.md
+20
View File
@@ -0,0 +1,20 @@
---
'@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
'@backstage/cli': patch
---
Updated link to docs.
docs/README.md
-3
View File
@@ -1,3 +0,0 @@
# Documentation
The Backstage documentation is available at https://backstage.io/docs
docs/openapi/definitions/auth.yaml
+1 -1
View File
@@ -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:
docs/plugins/structure-of-a-plugin.md
-2
View File
@@ -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)
microsite-next/docusaurus.config.js
+11
View File
@@ -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} */
microsite-next/package.json
+1
View File
@@ -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",
microsite-next/yarn.lock
+21
View File
@@ -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
packages/backend-app-api/README.md
+1 -1
View File
@@ -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/)
packages/backend-common/README.md
+1 -1
View File
@@ -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)
packages/backend-defaults/README.md
+1 -1
View File
@@ -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/)
packages/backend-dev-utils/README.md
+1 -1
View File
@@ -16,5 +16,5 @@ yarn add --cwd plugins/<plugin>-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/)
packages/backend-plugin-api/README.md
+1 -1
View File
@@ -16,5 +16,5 @@ yarn add --cwd plugins/<plugin>-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/)
packages/backend-tasks/README.md
+1 -1
View File
@@ -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)
packages/backend-test-utils/README.md
+1 -1
View File
@@ -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)
packages/backend/README.md
+1 -1
View File
@@ -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)
packages/cli-common/README.md
+1 -1
View File
@@ -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)
packages/cli/README.md
+1 -1
View File
@@ -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)
packages/codemods/README.md
+1 -1
View File
@@ -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)
packages/config-loader/README.md
+1 -1
View File
@@ -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)
packages/config/README.md
+1 -1
View File
@@ -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)
packages/create-app/templates/default-app/packages/backend/README.md
+1 -1
View File
@@ -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)
packages/dev-utils/README.md
+1 -1
View File
@@ -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)
packages/e2e-test/README.md
+1 -1
View File
@@ -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)
packages/test-utils/README.md
+1 -1
View File
@@ -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)
packages/theme/README.md
+1 -1
View File
@@ -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)