Merge pull request #3213 from backstage/rugvip/url-rewrite
rewrite repo location urls
This commit is contained in:
Patrik Oldsberg
@@ -34,5 +34,5 @@ app.listen(PORT, () => {
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/backend-common"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -55,9 +55,9 @@ in `app-config.yaml` under `catalog.locations`. For local development you can ov
|
||||
|
||||
We chose [Passport](http://www.passportjs.org/) as authentication platform due to its comprehensive set of supported authentication [strategies](http://www.passportjs.org/packages/).
|
||||
|
||||
Read more about the [auth-backend](https://github.com/spotify/backstage/blob/master/plugins/auth-backend/README.md) and [how to add a new provider](https://github.com/spotify/backstage/blob/master/docs/auth/add-auth-provider.md)
|
||||
Read more about the [auth-backend](https://github.com/backstage/backstage/blob/master/plugins/auth-backend/README.md) and [how to add a new provider](https://github.com/backstage/backstage/blob/master/docs/auth/add-auth-provider.md)
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -7,6 +7,6 @@ as well as by others that want to consume catalog data.
|
||||
|
||||
## Links
|
||||
|
||||
- [Default frontend part of the catalog](https://github.com/spotify/backstage/tree/master/plugins/catalog)
|
||||
- [Default backend part of the catalog](https://github.com/spotify/backstage/tree/master/plugins/catalog-backend)
|
||||
- [Default frontend part of the catalog](https://github.com/backstage/backstage/tree/master/plugins/catalog)
|
||||
- [Default backend part of the catalog](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend)
|
||||
- [The Backstage homepage](https://backstage.io)
|
||||
|
||||
@@ -6,4 +6,4 @@ metadata:
|
||||
spec:
|
||||
type: github
|
||||
targets:
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme/org.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/org.yaml
|
||||
|
||||
@@ -18,10 +18,10 @@ metadata:
|
||||
spec:
|
||||
type: github
|
||||
targets:
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme/infrastructure-group.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme/boxoffice-group.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme/backstage-group.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme/team-a-group.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme/team-b-group.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme/team-c-group.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/acme/team-d-group.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/infrastructure-group.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/boxoffice-group.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/backstage-group.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/team-a-group.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/team-b-group.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/team-c-group.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme/team-d-group.yaml
|
||||
|
||||
@@ -6,8 +6,8 @@ metadata:
|
||||
spec:
|
||||
type: github
|
||||
targets:
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/apis/hello-world-api.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/apis/petstore-api.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/apis/spotify-api.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/apis/streetlights-api.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/apis/swapi-graphql.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/apis/hello-world-api.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/apis/petstore-api.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/apis/spotify-api.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/apis/streetlights-api.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/apis/swapi-graphql.yaml
|
||||
|
||||
@@ -6,12 +6,12 @@ metadata:
|
||||
spec:
|
||||
type: github
|
||||
targets:
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/components/artist-lookup-component.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/components/petstore-component.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/components/playback-order-component.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/components/podcast-api-component.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/components/queue-proxy-component.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/components/searcher-component.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/components/playback-lib-component.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/components/www-artist-component.yaml
|
||||
- https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/components/shuffle-api-component.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/artist-lookup-component.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/petstore-component.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/playback-order-component.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/podcast-api-component.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/queue-proxy-component.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/searcher-component.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/playback-lib-component.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/www-artist-component.yaml
|
||||
- https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/shuffle-api-component.yaml
|
||||
|
||||
@@ -94,7 +94,7 @@ export class FieldFormatEntityPolicy implements EntityPolicy {
|
||||
: '';
|
||||
|
||||
throw new Error(
|
||||
`"${field}" is not valid;${message} To learn more about catalog file format, visit: https://github.com/spotify/backstage/blob/master/docs/architecture-decisions/adr002-default-catalog-file-format.md`,
|
||||
`"${field}" is not valid;${message} To learn more about catalog file format, visit: https://github.com/backstage/backstage/blob/master/docs/architecture-decisions/adr002-default-catalog-file-format.md`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -71,7 +71,7 @@ describe('LocationV1alpha1Validator', () => {
|
||||
|
||||
it('accepts good target', async () => {
|
||||
(entity as any).spec.target =
|
||||
'https://github.com/spotify/backstage/blob/master/plugins/catalog-backend/examples/artist-lookup-component.yaml';
|
||||
'https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/examples/artist-lookup-component.yaml';
|
||||
await expect(validator.check(entity)).resolves.toBe(true);
|
||||
});
|
||||
|
||||
@@ -87,8 +87,8 @@ describe('LocationV1alpha1Validator', () => {
|
||||
|
||||
it('accepts good targets', async () => {
|
||||
(entity as any).spec.targets = [
|
||||
'https://github.com/spotify/backstage/blob/master/plugins/catalog-backend/examples/artist-lookup-component.yaml',
|
||||
'https://github.com/spotify/backstage/blob/master/plugins/catalog-backend/examples/playback-order-component.yaml',
|
||||
'https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/examples/artist-lookup-component.yaml',
|
||||
'https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/examples/playback-order-component.yaml',
|
||||
];
|
||||
await expect(validator.check(entity)).resolves.toBe(true);
|
||||
});
|
||||
|
||||
@@ -8,5 +8,5 @@ Do not install this package directly, it is an internal package used by [@backst
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/cli-common"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -30,5 +30,5 @@ To try out the command locally, you can execute the following from the parent di
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/cli"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -8,5 +8,5 @@ Do not install this package directly, it is an internal package used by [@backst
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/config-loader"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -8,5 +8,5 @@ Do not install this package directly, it is an internal package used by [@backst
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/config"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -18,5 +18,5 @@ $ yarn add @backstage/core
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/core-api"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -18,5 +18,5 @@ $ yarn add @backstage/core
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/core"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -73,7 +73,7 @@ export const ErrorPage = ({
|
||||
</Link>
|
||||
... or if you think this is a bug, please file an{' '}
|
||||
<Link
|
||||
href="https://github.com/spotify/backstage/issues"
|
||||
href="https://github.com/backstage/backstage/issues"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
issue.
|
||||
|
||||
@@ -13,5 +13,5 @@ $ npx @backstage/create-app
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/create-app"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -81,23 +81,23 @@ catalog:
|
||||
locations:
|
||||
# Backstage example components
|
||||
- type: url
|
||||
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/all-components.yaml
|
||||
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-components.yaml
|
||||
|
||||
# Backstage example APIs
|
||||
- type: url
|
||||
target: https://github.com/spotify/backstage/blob/master/packages/catalog-model/examples/all-apis.yaml
|
||||
target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all-apis.yaml
|
||||
|
||||
# Backstage example templates
|
||||
- type: github
|
||||
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml
|
||||
target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml
|
||||
rules:
|
||||
- allow: [Template]
|
||||
- type: github
|
||||
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/springboot-grpc-template/template.yaml
|
||||
target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/springboot-grpc-template/template.yaml
|
||||
rules:
|
||||
- allow: [Template]
|
||||
- type: github
|
||||
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/create-react-app/template.yaml
|
||||
target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/create-react-app/template.yaml
|
||||
rules:
|
||||
- allow: [Template]
|
||||
- type: github
|
||||
@@ -105,6 +105,6 @@ catalog:
|
||||
rules:
|
||||
- allow: [Template]
|
||||
- type: github
|
||||
target: https://github.com/spotify/backstage/blob/master/plugins/scaffolder-backend/sample-templates/docs-template/template.yaml
|
||||
target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/docs-template/template.yaml
|
||||
rules:
|
||||
- allow: [Template]
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
apiVersion: backstage.io/v1alpha1
|
||||
apiVersion: backstage.io/v1alpha1
|
||||
kind: Component
|
||||
metadata:
|
||||
name: {{name}}
|
||||
name: {{name}}
|
||||
description: An example of a Backstage application.
|
||||
# Example for optional annotations
|
||||
# annotations:
|
||||
# annotations:
|
||||
# github.com/project-slug: spotify/backstage
|
||||
# backstage.io/techdocs-ref: github:https://github.com/spotify/backstage.git
|
||||
# backstage.io/techdocs-ref: github:https://github.com/backstage/backstage.git
|
||||
spec:
|
||||
type: website
|
||||
owner: john@example.com
|
||||
lifecycle: experimental
|
||||
lifecycle: experimental
|
||||
|
||||
@@ -56,11 +56,11 @@ to its comprehensive set of supported authentication
|
||||
[strategies](http://www.passportjs.org/packages/).
|
||||
|
||||
Read more about the
|
||||
[auth-backend](https://github.com/spotify/backstage/blob/master/plugins/auth-backend/README.md)
|
||||
[auth-backend](https://github.com/backstage/backstage/blob/master/plugins/auth-backend/README.md)
|
||||
and
|
||||
[how to add a new provider](https://github.com/spotify/backstage/blob/master/docs/auth/add-auth-provider.md)
|
||||
[how to add a new provider](https://github.com/backstage/backstage/blob/master/docs/auth/add-auth-provider.md)
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -20,5 +20,5 @@ $ yarn add -D @backstage/dev-utils
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/dev-utils"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/docgen"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -40,7 +40,7 @@ export default class ApiDocPrinter {
|
||||
'The following is a list of all Utility APIs defined by `@backstage/core`.',
|
||||
'They are available to use by plugins and components, and can be accessed ',
|
||||
'using the `useApi` hook, also provided by `@backstage/core`.',
|
||||
'For more information, see https://github.com/spotify/backstage/blob/master/docs/api/utility-apis.md.',
|
||||
'For more information, see https://github.com/backstage/backstage/blob/master/docs/api/utility-apis.md.',
|
||||
);
|
||||
|
||||
for (const api of apiDocs) {
|
||||
|
||||
@@ -20,7 +20,7 @@ import { MarkdownPrinter, TypeLink } from './types';
|
||||
import { execSync } from 'child_process';
|
||||
|
||||
// TODO(Rugvip): provide through options?
|
||||
const GH_BASE_URL = 'https://github.com/spotify/backstage';
|
||||
const GH_BASE_URL = 'https://github.com/backstage/backstage';
|
||||
|
||||
const COMMIT_SHA =
|
||||
process.env.COMMIT_SHA ||
|
||||
|
||||
@@ -19,7 +19,7 @@ import { Highlighter, MarkdownPrinter, TypeLink } from './types';
|
||||
import { execSync } from 'child_process';
|
||||
|
||||
// TODO(Rugvip): provide through options?
|
||||
const GH_BASE_URL = 'https://github.com/spotify/backstage';
|
||||
const GH_BASE_URL = 'https://github.com/backstage/backstage';
|
||||
|
||||
const COMMIT_SHA =
|
||||
process.env.COMMIT_SHA || execSync('git rev-parse HEAD').toString('utf8');
|
||||
|
||||
@@ -20,5 +20,5 @@ If you make changes to other packages you will need to rerun `yarn tsc && yarn b
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/e2e-test"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
|
||||
/**
|
||||
* When building storybook, we can have warnings which may cause issues in the future. One of the example case is
|
||||
* https://github.com/spotify/backstage/issues/718. To make sure new warnings are not introduced with new PRs, we
|
||||
* https://github.com/backstage/backstage/issues/718. To make sure new warnings are not introduced with new PRs, we
|
||||
* want to fail CI builds if there are warnings when building storybook.
|
||||
*
|
||||
* This webpack plugin makes sure the CI builds fail on Webpack warnings. We also have an allowlist of warnings here
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# TechDocs CLI
|
||||
|
||||
Check out the [TechDocs README](https://github.com/spotify/backstage/blob/master/plugins/techdocs/README.md) to learn more.
|
||||
Check out the [TechDocs README](https://github.com/backstage/backstage/blob/master/plugins/techdocs/README.md) to learn more.
|
||||
|
||||
**WIP: This cli is a work in progress. It is not ready for use yet. Follow our progress on [the Backstage Discord](https://discord.gg/MUpMjP2) under #docs-like-code or on [our GitHub Milestone](https://github.com/spotify/backstage/milestone/15).**
|
||||
**WIP: This cli is a work in progress. It is not ready for use yet. Follow our progress on [the Backstage Discord](https://discord.gg/MUpMjP2) under #docs-like-code or on [our GitHub Milestone](https://github.com/backstage/backstage/milestone/15).**
|
||||
|
||||
## Prerequisities
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/techdocs-cli"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# techdocs-container
|
||||
|
||||
This is the Docker container that powers the creation of static documentation sites that are supported by [TechDocs](https://github.com/spotify/backstage/blob/master/plugins/techdocs).
|
||||
This is the Docker container that powers the creation of static documentation sites that are supported by [TechDocs](https://github.com/backstage/backstage/blob/master/plugins/techdocs).
|
||||
|
||||
## Getting Started
|
||||
|
||||
@@ -26,6 +26,6 @@ This container is published on DockerHub - https://hub.docker.com/r/spotify/tech
|
||||
|
||||
The publishing is configured by [Automated Builds](https://hub.docker.com/repository/docker/spotify/techdocs/builds/edit) feature on Docker Hub which is triggered from GitHub (on new commits and releases). @spotify/techdocs-core team has access to the settings.
|
||||
|
||||
The `latest` tag on Docker Hub points to the recent commits in the `master` branch. The [version tags](https://hub.docker.com/r/spotify/techdocs/tags) (e.g. v0.1.1-alpha.24) point to the GitHub tags created from [releases](https://github.com/spotify/backstage/releases) of this GitHub repository.
|
||||
The `latest` tag on Docker Hub points to the recent commits in the `master` branch. The [version tags](https://hub.docker.com/r/spotify/techdocs/tags) (e.g. v0.1.1-alpha.24) point to the GitHub tags created from [releases](https://github.com/backstage/backstage/releases) of this GitHub repository.
|
||||
|
||||
Note: We recommend using a specific version of the container instead of `latest` release for stability and avoiding unexpected changes.
|
||||
|
||||
@@ -28,7 +28,7 @@ setup(
|
||||
long_description=long_description,
|
||||
long_description_content_type="text/markdown",
|
||||
keywords="mkdocs",
|
||||
url="https://github.com/spotify/backstage",
|
||||
url="https://github.com/backstage/backstage",
|
||||
author="TechDocs Core",
|
||||
author_email="pulp-fiction@spotify.com",
|
||||
license="Apache-2.0",
|
||||
|
||||
@@ -11,5 +11,5 @@ The reason this package exists is to allow the Backstage core packages to use th
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/test-utils-core"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -18,5 +18,5 @@ $ yarn add -D @backstage/test-utils
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/test-utils"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
@@ -18,5 +18,5 @@ $ yarn add @backstage/theme
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md)
|
||||
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
|
||||
- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
"homepage": "https://backstage.io",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/spotify/backstage",
|
||||
"url": "https://github.com/backstage/backstage",
|
||||
"directory": "packages/theme"
|
||||
},
|
||||
"keywords": [
|
||||
|
||||
Reference in New Issue
Block a user