Skip to content

Commit

Permalink
Replace spotify with backstage (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
blueswen committed Jan 3, 2024
1 parent c778b30 commit a007de2
Show file tree
Hide file tree
Showing 11 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
✚ This plugin enables you to build multiple sets of documentation in a single Mkdocs. It is designed to address writing documentation in Spotify's largest and most business-critical codebases (typically monoliths or monorepos).

✏️ [Blog Post](https://labs.spotify.com/2019/10/01/solving-documentation-for-monoliths-and-monorepos/) | 🐍 [Python Package](https://pypi.org/project/mkdocs-monorepo-plugin/) | ✚ [Demo](https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/) | 📕 [Docs](https://spotify.github.io/mkdocs-monorepo-plugin/)
✏️ [Blog Post](https://labs.spotify.com/2019/10/01/solving-documentation-for-monoliths-and-monorepos/) | 🐍 [Python Package](https://pypi.org/project/mkdocs-monorepo-plugin/) | ✚ [Demo](https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/) | 📕 [Docs](https://backstage.github.io/mkdocs-monorepo-plugin/)

## Features

Expand Down
2 changes: 1 addition & 1 deletion sample-docs/docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This explains how to authenticate.
To authenticate, simply pass in your access token in the form of a `Authorization: Bearer {access_token}` header in your HTTP request to our API.

- Markdown source: `sample-docs/docs/authentication.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/authentication/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/authentication/>
2 changes: 1 addition & 1 deletion sample-docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ This contains the documentation for our Developer Platform.
- [v3 API Reference](./versions/v3/reference.md)

- Markdown source: `sample-docs/docs/index.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/>
2 changes: 1 addition & 1 deletion sample-docs/v1/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
This contains the changelog for the v1 API.

- Markdown source: `sample-docs/v1/docs/changelog.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v1/changelog/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v1/changelog/>
2 changes: 1 addition & 1 deletion sample-docs/v1/docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Parameters:
Returns a list of cats that match the search query.

- Markdown source: `sample-docs/v1/docs/reference.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v1/reference/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v1/reference/>
2 changes: 1 addition & 1 deletion sample-docs/v2/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
This contains the changelog for the v2 API.

- Markdown source: `sample-docs/v2/docs/changelog.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v2/changelog/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v2/changelog/>
2 changes: 1 addition & 1 deletion sample-docs/v2/docs/migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
This contains the migration guide to the v2 API from the v1 API.

- Markdown source: `sample-docs/v2/docs/migrating.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v2/migrating/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v2/migrating/>
2 changes: 1 addition & 1 deletion sample-docs/v2/docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Parameters:
Returns a list of cats that match the search query.

- Markdown source: `sample-docs/v2/docs/reference.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v2/reference/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v2/reference/>
2 changes: 1 addition & 1 deletion sample-docs/v3/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
This contains the changelog for the v3 API.

- Markdown source: `sample-docs/v3/docs/changelog.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v3/changelog/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v3/changelog/>
2 changes: 1 addition & 1 deletion sample-docs/v3/docs/migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
This contains the migration guide to the v3 API from the v2 API.

- Markdown source: `sample-docs/v3/docs/migrating.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v3/migrating/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v3/migrating/>
4 changes: 2 additions & 2 deletions sample-docs/v3/docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Parameters:
Returns a list of cats that match the search query.

- Markdown source: `sample-docs/v3/docs/reference.md`
- Permalink: <https://spotify.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v3/reference/>
- Permalink: <https://backstage.github.io/mkdocs-monorepo-plugin/monorepo-example/versions/v3/reference/>

## GET /v3/cat/:name/lives_left

Returns how many lives the cat named `:name` still has left.
Returns how many lives the cat named `:name` still has left.

0 comments on commit a007de2

Please sign in to comment.