From f59dd3a073435cc630dc3e73916fdf8c4310ab4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20=C3=85lund?= Date: Wed, 15 Jul 2020 12:24:15 +0200 Subject: [PATCH] [Docs] Fix broken links and more --- docs/README.md | 1 + docs/auth/index.md | 4 ++-- docs/auth/oauth.md | 2 +- .../contributing-to-storybook.md | 0 docs/dls/index.md | 0 docs/{getting-started => dls}/running-storybook.png | Bin docs/{getting-started => dls}/storybook-page.png | Bin docs/getting-started/index.md | 6 +++--- mkdocs.yml | 1 + 9 files changed, 8 insertions(+), 6 deletions(-) rename docs/{getting-started => dls}/contributing-to-storybook.md (100%) delete mode 100644 docs/dls/index.md rename docs/{getting-started => dls}/running-storybook.png (100%) rename docs/{getting-started => dls}/storybook-page.png (100%) diff --git a/docs/README.md b/docs/README.md index ee83b24050..f8385fb4c8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -68,6 +68,7 @@ better yet, a pull request. - Designing for Backstage - [Backstage Design Language System (DLS)](dls/design.md) - [Storybook -- reusable UI components](dls/storybook.md) + - [Contributing to Storybook](dls/contributing-to-storybook.md) - [Figma resources](dls/figma.md) - API references - TypeScript API diff --git a/docs/auth/index.md b/docs/auth/index.md index 9809f57168..0cb56501ab 100644 --- a/docs/auth/index.md +++ b/docs/auth/index.md @@ -25,8 +25,8 @@ as possible to create new plugins, and an auth solution based on user-to-server OAuth helps in that regard. The method with which frontend plugins request access to third party services is -through [Utility APIs](../getting-started/utility-apis.md) for each service -provider. For a full list of providers, see [TODO](#TODO). +through [Utility APIs](../api/utility-apis.md) for each service provider. For a +full list of providers, see [TODO](#TODO). ### Identity - WIP diff --git a/docs/auth/oauth.md b/docs/auth/oauth.md index 519cfe1d85..981ae18057 100644 --- a/docs/auth/oauth.md +++ b/docs/auth/oauth.md @@ -8,7 +8,7 @@ to various third party APIs. There are occasions when the user wants to perform actions towards third party services that require authorization via OAuth. Backstage provides standardized -[Utility APIs](../getting-started/utility-apis.md) such as the +[Utility APIs](../api/utility-apis.md) such as the [GoogleAuthApi](../../packages/core-api/src/apis/definitions/auth.ts) for that use-case. Backstage also includes a set of implementations of these APIs that integrate with the [auth-backend](../../plugins/auth-backend) plugin to provide diff --git a/docs/getting-started/contributing-to-storybook.md b/docs/dls/contributing-to-storybook.md similarity index 100% rename from docs/getting-started/contributing-to-storybook.md rename to docs/dls/contributing-to-storybook.md diff --git a/docs/dls/index.md b/docs/dls/index.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/getting-started/running-storybook.png b/docs/dls/running-storybook.png similarity index 100% rename from docs/getting-started/running-storybook.png rename to docs/dls/running-storybook.png diff --git a/docs/getting-started/storybook-page.png b/docs/dls/storybook-page.png similarity index 100% rename from docs/getting-started/storybook-page.png rename to docs/dls/storybook-page.png diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index af56e0627f..2770b7a154 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -62,8 +62,8 @@ collection of tutorials that will guide you through setting up and extending an instance of Backstage with your own plugins. - [Development Environment](development-environment.md) -- [Create a Backstage Plugin](create-a-plugin.md) -- [Structure of a Plugin](structure-of-a-plugin.md) -- [Utility APIs](utility-apis.md) +- [Create a Backstage Plugin](../plugins/create-a-plugin.md) +- [Structure of a Plugin](../plugins/structure-of-a-plugin.md) +- [Utility APIs](../api/utility-apis.md) [Back to Docs](../README.md) diff --git a/mkdocs.yml b/mkdocs.yml index 46367873e2..7c5a672636 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,6 +66,7 @@ nav: - Designing for Backstage: - Backstage Design Language System (DLS): 'dls/design.md' - Storybook -- reusable UI components: 'dls/storybook.md' + - Contributing to Storybook: 'dls/contributing-to-storybook.md' - Figma resources: 'dls/figma.md' - API references: - TypeScript APIs: