rewrite repo location urls
This commit is contained in:
@@ -33,7 +33,7 @@ Currently the build process of techdocs-backend is split up in these three stage
|
||||
- Generators
|
||||
- Publishers
|
||||
|
||||
Preparers read your entity data and creates a working directory with your documentation source code. For example if you have set your `backstage.io/techdocs-ref` to `github:https://github.com/spotify/backstage.git` it will clone that repository to a temp folder and pass that on to the generator.
|
||||
Preparers read your entity data and creates a working directory with your documentation source code. For example if you have set your `backstage.io/techdocs-ref` to `github:https://github.com/backstage/backstage.git` it will clone that repository to a temp folder and pass that on to the generator.
|
||||
|
||||
Generators takes the prepared source and runs the `techdocs-container` on it. It then passes on the output folder of that build to the publisher.
|
||||
|
||||
@@ -43,5 +43,5 @@ Any of these can be extended. If we want to publish to a external static file se
|
||||
|
||||
## Links
|
||||
|
||||
- [Frontend part of the plugin](https://github.com/spotify/backstage/tree/master/plugins/techdocs)
|
||||
- [Frontend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/techdocs)
|
||||
- [The Backstage homepage](https://backstage.io)
|
||||
|
||||
@@ -4,7 +4,7 @@ metadata:
|
||||
name: documented-component
|
||||
description: A Service with TechDocs documentation
|
||||
annotations:
|
||||
backstage.io/techdocs-ref: 'github:https://github.com/spotify/backstage/blob/master/plugins/techdocs-backend/examples/documented-component'
|
||||
backstage.io/techdocs-ref: 'github:https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend/examples/documented-component'
|
||||
spec:
|
||||
type: service
|
||||
lifecycle: experimental
|
||||
|
||||
@@ -51,7 +51,7 @@ describe('commonGit preparer', () => {
|
||||
|
||||
const mockEntity = createMockEntity({
|
||||
'backstage.io/techdocs-ref':
|
||||
'github:https://github.com/spotify/backstage/blob/master/plugins/techdocs-backend/examples/documented-component',
|
||||
'github:https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend/examples/documented-component',
|
||||
});
|
||||
|
||||
const tempDocsPath = await preparer.prepare(mockEntity);
|
||||
|
||||
@@ -78,7 +78,7 @@ describe('directory preparer', () => {
|
||||
|
||||
const mockEntity = createMockEntity({
|
||||
'backstage.io/managed-by-location':
|
||||
'github:https://github.com/spotify/backstage/blob/master/catalog-info.yaml',
|
||||
'github:https://github.com/backstage/backstage/blob/master/catalog-info.yaml',
|
||||
'backstage.io/techdocs-ref': 'dir:./docs',
|
||||
});
|
||||
|
||||
|
||||
Reference in New Issue
Block a user