rewrite repo location urls
This commit is contained in:
Patrik Oldsberg
@@ -17,14 +17,14 @@ This page answers frequently asked questions about [TechDocs](README.md).
|
||||
|
||||
TechDocs is using [MkDocs](https://www.mkdocs.org/) to build project
|
||||
documentation under the hood. Documentation built with the
|
||||
[techdocs-container](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/README.md)
|
||||
[techdocs-container](https://github.com/backstage/backstage/blob/master/packages/techdocs-container/README.md)
|
||||
is using the MkDocs
|
||||
[Material Theme](https://github.com/squidfunk/mkdocs-material).
|
||||
|
||||
#### What is the mkdocs-techdocs-core plugin?
|
||||
|
||||
The
|
||||
[mkdocs-techdocs-core](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/techdocs-core/README.md)
|
||||
[mkdocs-techdocs-core](https://github.com/backstage/backstage/blob/master/packages/techdocs-container/techdocs-core/README.md)
|
||||
package is a MkDocs Plugin that works like a wrapper around multiple MkDocs
|
||||
plugins (e.g.
|
||||
[MkDocs Monorepo Plugin](https://github.com/spotify/mkdocs-monorepo-plugin)) as
|
||||
|
||||
@@ -40,10 +40,10 @@ about TechDocs and the philosophy in its
|
||||
| [TechDocs V.2 🔮⌛][v2] | Easy adoption of TechDocs (whatever environment you have) [See V.2 Use Cases.](#techdocs-v2) |
|
||||
| [TechDocs V.3 🔮⌛][v3] | Build a widget (plugin) framework so that contributors can easily contribute features to TechDocs - that others can use. [See V.3 Use Cases.](#techdocs-v3) |
|
||||
|
||||
[v0]: https://github.com/spotify/backstage/milestone/15
|
||||
[v1]: https://github.com/spotify/backstage/milestone/16
|
||||
[v2]: https://github.com/spotify/backstage/milestone/22
|
||||
[v3]: https://github.com/spotify/backstage/milestone/17
|
||||
[v0]: https://github.com/backstage/backstage/milestone/15
|
||||
[v1]: https://github.com/backstage/backstage/milestone/16
|
||||
[v2]: https://github.com/backstage/backstage/milestone/22
|
||||
[v3]: https://github.com/backstage/backstage/milestone/17
|
||||
|
||||
<!-- TODO: Add link to milestone for v3 -->
|
||||
|
||||
@@ -117,10 +117,10 @@ migrate Spotify's existing TechDocs features to open source.
|
||||
[creating and publishing documentation]: creating-and-publishing.md
|
||||
[faq]: FAQ.md 'Frequently asked questions'
|
||||
[techdocs/frontend]:
|
||||
https://github.com/spotify/backstage/blob/master/plugins/techdocs
|
||||
https://github.com/backstage/backstage/blob/master/plugins/techdocs
|
||||
[techdocs/backend]:
|
||||
https://github.com/spotify/backstage/blob/master/plugins/techdocs-backend
|
||||
https://github.com/backstage/backstage/blob/master/plugins/techdocs-backend
|
||||
[techdocs/container]:
|
||||
https://github.com/spotify/backstage/blob/master/packages/techdocs-container
|
||||
https://github.com/backstage/backstage/blob/master/packages/techdocs-container
|
||||
[techdocs/cli]:
|
||||
https://github.com/spotify/backstage/blob/master/packages/techdocs-cli
|
||||
https://github.com/backstage/backstage/blob/master/packages/techdocs-cli
|
||||
|
||||
@@ -14,7 +14,7 @@ The TechDocs Core Plugin is an [MkDocs](https://www.mkdocs.org/) plugin created
|
||||
as a wrapper around multiple MkDocs plugins and Python Markdown extensions to
|
||||
standardize the configuration of MkDocs used for TechDocs.
|
||||
|
||||
[TechDocs Core](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/techdocs-core/README.md)
|
||||
[TechDocs Core](https://github.com/backstage/backstage/blob/master/packages/techdocs-container/techdocs-core/README.md)
|
||||
|
||||
### TechDocs container
|
||||
|
||||
@@ -23,14 +23,14 @@ The TechDocs container is a Docker container available at
|
||||
pages, including stylesheets and scripts from Python flavored Markdown, through
|
||||
MkDocs.
|
||||
|
||||
[TechDocs Container](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/README.md)
|
||||
[TechDocs Container](https://github.com/backstage/backstage/blob/master/packages/techdocs-container/README.md)
|
||||
|
||||
### TechDocs publisher
|
||||
|
||||
The `techdocs-backend` plugin currently comes with one publisher -
|
||||
`LocalPublish`.
|
||||
|
||||
[TechDocs Backend](https://github.com/spotify/backstage/tree/master/plugins/techdocs-backend)
|
||||
[TechDocs Backend](https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend)
|
||||
|
||||
More standalone publishers will come in the near future...
|
||||
|
||||
@@ -41,7 +41,7 @@ documentation for publishing. Currently it mostly acts as a wrapper around the
|
||||
TechDocs container and provides an easy-to-use interface for our docker
|
||||
container.
|
||||
|
||||
[TechDocs CLI](https://github.com/spotify/backstage/blob/master/packages/techdocs-cli/README.md)
|
||||
[TechDocs CLI](https://github.com/backstage/backstage/blob/master/packages/techdocs-cli/README.md)
|
||||
|
||||
### TechDocs Reader
|
||||
|
||||
@@ -53,7 +53,7 @@ The TechDocs Reader purpose is also to open up the opportunity to integrate
|
||||
TechDocs widgets for a customized full-featured TechDocs experience.
|
||||
([coming soon V.3](./README.md#project-roadmap))
|
||||
|
||||
[TechDocs Reader](https://github.com/spotify/backstage/blob/master/plugins/techdocs/src/reader/README.md)
|
||||
[TechDocs Reader](https://github.com/backstage/backstage/blob/master/plugins/techdocs/src/reader/README.md)
|
||||
|
||||
### Transformers
|
||||
|
||||
@@ -62,4 +62,4 @@ Reader. The reason why transformers were introduced was to provide a way to
|
||||
transform the HTML content on pre and post render (e.g. rewrite docs links or
|
||||
modify css).
|
||||
|
||||
[Transformers API docs](https://github.com/spotify/backstage/blob/master/plugins/techdocs/src/reader/README.md)
|
||||
[Transformers API docs](https://github.com/backstage/backstage/blob/master/plugins/techdocs/src/reader/README.md)
|
||||
|
||||
Reference in New Issue
Block a user