diff --git a/docs/FAQ.md b/docs/FAQ.md index 5d10e9c7d0..d230e682a4 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -17,7 +17,7 @@ brand. No, but it can be! Backstage is designed to be a developer portal for all your infrastructure tooling, services, and documentation. So, it's not a monitoring platform — but that doesn't mean you can't integrate a monitoring tool into -Backstage by writing [a plugin](/docs/FAQ.md#what-is-a-plugin-in-backstage). +Backstage by writing [a plugin](#what-is-a-plugin-in-backstage). ### How is Backstage licensed? @@ -38,7 +38,7 @@ more, read our blog post, Yes, we've already started releasing open source versions of some of the plugins we use here, and we'll continue to do so. -[Plugins](/docs/FAQ.md#what-is-a-plugin-in-backstage) are the building blocks of +[Plugins](#what-is-a-plugin-in-backstage) are the building blocks of functionality in Backstage. We have over 120 plugins inside Spotify — many of those are specialized for our use, so will remain internal and proprietary to us. But we estimate that about a third of our existing plugins make good open @@ -145,7 +145,7 @@ This makes it easier to create, find, and update documentation. We hope to release [the open source version](https://github.com/spotify/backstage/issues/687) in the future. (See also: -"[Will Spotify's internal plugins be open sourced, too?](/docs/FAQ.md#will-spotifys-internal-plugins-be-open-sourced-too)" +"[Will Spotify's internal plugins be open sourced, too?](#will-spotifys-internal-plugins-be-open-sourced-too)" above) ### Are you planning to have plugins baked into the repo? Or should they be developed in separate repos? diff --git a/docs/features/software-catalog/installation.md b/docs/features/software-catalog/installation.md index 260972aeac..397abcc6b0 100644 --- a/docs/features/software-catalog/installation.md +++ b/docs/features/software-catalog/installation.md @@ -49,7 +49,7 @@ Where `backendUrl` is the `backend.baseUrl` from config, i.e. `const backendUrl = config.getString('backend.baseUrl')`. The catalog components depend on a number of other -[Utility APIs](/docs/api/utility-apis.md) to function, including at least the +[Utility APIs](../../api/utility-apis.md) to function, including at least the `ErrorApi` and `StorageApi`. You can find an example of how to install these in your app [here](https://github.com/spotify/backstage/blob/61c3a7e5b750dc7c059ef16b188594d31b2c04c2/packages/app/src/apis.ts#L80). diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index 925c145259..0508d1f3f7 100644 --- a/docs/features/software-templates/installation.md +++ b/docs/features/software-templates/installation.md @@ -143,8 +143,8 @@ const service = createServiceBuilder(module) At this point the scaffolder backend is installed in your backend package, but you will not have any templates available to use. These need to be added to the software catalog, as they are represented as entities of kind -[Template](/docs/features/software-catalog/descriptor-format.md#kind-template). -You can find out more about adding templates [here](./adding-templates.md). +[Template](../software-catalog/descriptor-format.md#kind-template). You can find +out more about adding templates [here](./adding-templates.md). To get up and running and try out some templates quickly, you can add some of our example templates through static configuration. Add the following to the