From 14466940f740f9b139ae45ee5c488f9eaba84fbe Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 5 Jan 2021 13:42:31 -0500 Subject: [PATCH 1/3] Single line metadata and prettier ignore --- docs/auth/oauth.md | 5 ++--- docs/dls/figma.md | 4 ++-- docs/features/software-templates/index.md | 4 ++-- docs/features/techdocs/README.md | 4 ++-- docs/features/techdocs/concepts.md | 4 ++-- docs/features/techdocs/configuration.md | 4 ++-- docs/getting-started/development-environment.md | 4 ++-- docs/overview/adopting.md | 4 ++-- docs/overview/background.md | 4 ++-- docs/overview/stability-index.md | 5 ++--- docs/overview/vision.md | 4 ++-- docs/overview/what-is-backstage.md | 4 ++-- docs/plugins/call-existing-api.md | 4 ++-- docs/support/project-structure.md | 4 ++-- 14 files changed, 28 insertions(+), 30 deletions(-) diff --git a/docs/auth/oauth.md b/docs/auth/oauth.md index 0655175b5826d..4209b81279eb6 100644 --- a/docs/auth/oauth.md +++ b/docs/auth/oauth.md @@ -1,9 +1,8 @@ --- id: oauth title: OAuth and OpenID Connect -description: This section describes how Backstage allows plugins to request -OAuth Access Tokens and OpenID Connect ID Tokens on behalf of the user, to be -used for auth to various third party APIs +# prettier-ignore +description: This section describes how Backstage allows plugins to request OAuth Access Tokens and OpenID Connect ID Tokens on behalf of the user, to be used for auth to various third party APIs --- This section describes how Backstage allows plugins to request OAuth Access diff --git a/docs/dls/figma.md b/docs/dls/figma.md index c5a33d15c2b31..21a05d281847d 100644 --- a/docs/dls/figma.md +++ b/docs/dls/figma.md @@ -1,8 +1,8 @@ --- id: figma title: Figma -description: Documentation on using Figma to build your own plugins for -Backstage +# prettier-ignore +description: Documentation on using Figma to build your own plugins for Backstage --- We have a [Figma component library](https://www.figma.com/@backstage) that you diff --git a/docs/features/software-templates/index.md b/docs/features/software-templates/index.md index 3ebb426466f80..1034ffef0f528 100644 --- a/docs/features/software-templates/index.md +++ b/docs/features/software-templates/index.md @@ -2,8 +2,8 @@ id: software-templates-index title: Backstage Software Templates sidebar_label: Overview -description: The Software Templates part of Backstage is a tool that can help -you create Components inside Backstage +# prettier-ignore +description: The Software Templates part of Backstage is a tool that can help you create Components inside Backstage --- The Software Templates part of Backstage is a tool that can help you create diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index f4e89d8f6f5f9..5f402b1e53837 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -2,8 +2,8 @@ id: techdocs-overview title: TechDocs Documentation sidebar_label: Overview -description: TechDocs is Spotify’s homegrown docs-like-code solution built -directly into Backstage +# prettier-ignore +description: TechDocs is Spotify’s homegrown docs-like-code solution built directly into Backstage --- ## What is it? diff --git a/docs/features/techdocs/concepts.md b/docs/features/techdocs/concepts.md index 26254a7e124d3..408f092ebdabd 100644 --- a/docs/features/techdocs/concepts.md +++ b/docs/features/techdocs/concepts.md @@ -1,8 +1,8 @@ --- id: concepts title: Concepts -description: Documentation on concepts that are introduced with -Spotify's docs-like-code solution in Backstage +# prettier-ignore +description: Documentation on concepts that are introduced with Spotify's docs-like-code solution in Backstage --- This page describes concepts that are introduced with Spotify's docs-like-code diff --git a/docs/features/techdocs/configuration.md b/docs/features/techdocs/configuration.md index b3cb349778784..862f8bb080a94 100644 --- a/docs/features/techdocs/configuration.md +++ b/docs/features/techdocs/configuration.md @@ -1,8 +1,8 @@ --- id: configuration title: TechDocs Configuration Options -description: - Reference documentation for configuring TechDocs using app-config.yaml +# prettier-ignore +description: Reference documentation for configuring TechDocs using app-config.yaml --- Using the `app-config.yaml` in the Backstage app, you can configure TechDocs diff --git a/docs/getting-started/development-environment.md b/docs/getting-started/development-environment.md index c5275114cec0c..b5ff3885b38a4 100644 --- a/docs/getting-started/development-environment.md +++ b/docs/getting-started/development-environment.md @@ -1,8 +1,8 @@ --- id: development-environment title: Development Environment -description: Documentation on how to get set up for doing development on -the Backstage repository +# prettier-ignore +description: Documentation on how to get set up for doing development on the Backstage repository --- This section describes how to get set up for doing development on the Backstage diff --git a/docs/overview/adopting.md b/docs/overview/adopting.md index 0d404d5cb497a..152be21a2c345 100644 --- a/docs/overview/adopting.md +++ b/docs/overview/adopting.md @@ -1,8 +1,8 @@ --- id: adopting title: Strategies for adopting -description: Documentation on some general best practices that have been key -to Backstage's success inside Spotify +# prettier-ignore +description: Documentation on some general best practices that have been key to Backstage's success inside Spotify --- This document outlines some general best practices that have been key to diff --git a/docs/overview/background.md b/docs/overview/background.md index aca46614c2fa7..0c22396e7250a 100644 --- a/docs/overview/background.md +++ b/docs/overview/background.md @@ -1,8 +1,8 @@ --- id: background title: The Spotify Story -description: Backstage was born out of necessity at Spotify. We found that as we grew, our -infrastructure was becoming more fragmented, our engineers less productive. +# prettier-ignore +description: Backstage was born out of necessity at Spotify. We found that as we grew, our infrastructure was becoming more fragmented, our engineers less productive. --- Backstage was born out of necessity at Spotify. We found that as we grew, our diff --git a/docs/overview/stability-index.md b/docs/overview/stability-index.md index c53193f0631db..a82dafa7769b7 100644 --- a/docs/overview/stability-index.md +++ b/docs/overview/stability-index.md @@ -1,9 +1,8 @@ --- id: stability-index title: Stability Index -description: - An overview of the commitment to stability for different parts of the - Backstage codebase. +# prettier-ignore +description: An overview of the commitment to stability for different parts of the Backstage codebase. --- ## Overview diff --git a/docs/overview/vision.md b/docs/overview/vision.md index c17e2b17ba4b5..f6d6af90dde4d 100644 --- a/docs/overview/vision.md +++ b/docs/overview/vision.md @@ -1,8 +1,8 @@ --- id: vision title: Vision -description: Goal is to provide engineers with the best developer experience in -the world +# prettier-ignore +description: Goal is to provide engineers with the best developer experience in the world --- Our goal is to provide engineers with the best developer experience in the diff --git a/docs/overview/what-is-backstage.md b/docs/overview/what-is-backstage.md index b414e628536cc..ec824a1e1182c 100644 --- a/docs/overview/what-is-backstage.md +++ b/docs/overview/what-is-backstage.md @@ -1,8 +1,8 @@ --- id: what-is-backstage title: What is Backstage? -description: Backstage is an open platform for building developer portals. -Powered by a centralized service catalog, Backstage restores order to your microservices and infrastructure +# prettier-ignore +description: Backstage is an open platform for building developer portals. Powered by a centralized service catalog, Backstage restores order to your microservices and infrastructure --- ![service-catalog](https://backstage.io/blog/assets/6/header.png) diff --git a/docs/plugins/call-existing-api.md b/docs/plugins/call-existing-api.md index 75e054d2b9919..5dbf7988c9569 100644 --- a/docs/plugins/call-existing-api.md +++ b/docs/plugins/call-existing-api.md @@ -1,8 +1,8 @@ --- id: call-existing-api title: Call Existing API -description: Describes the various options that Backstage frontend plugins have, -in communicating with service APIs that already exist +# prettier-ignore +description: Describes the various options that Backstage frontend plugins have, in communicating with service APIs that already exist --- This article describes the various options that Backstage frontend plugins have, diff --git a/docs/support/project-structure.md b/docs/support/project-structure.md index a30288e85e69d..bb2c02ec76126 100644 --- a/docs/support/project-structure.md +++ b/docs/support/project-structure.md @@ -1,8 +1,8 @@ --- id: project-structure title: Backstage Project Structure -description: - Introduction to files and folders in the Backstage Project repository +# prettier-ignore +description: Introduction to files and folders in the Backstage Project repository --- Backstage is a complex project, and the GitHub repository contains many From ea071d5f6c17494e0bc760d3de6d6a09cfe225bd Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 5 Jan 2021 13:42:50 -0500 Subject: [PATCH 2/3] Proper case vendor name --- docs/features/software-catalog/descriptor-format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 763acd226155c..046a220061539 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -268,7 +268,7 @@ identical in use to Their purpose is mainly, but not limited, to reference into external systems. This could for example be a reference to the git ref the entity was ingested -from, to monitoring and logging systems, to pagerduty schedules, etc. Users may +from, to monitoring and logging systems, to PagerDuty schedules, etc. Users may add these to descriptor YAML files, but in addition to this automated systems may also add annotations, either during ingestion into the catalog, or at a later time. From a823f2bc409b195cfe937414b9bef40dd9db9dbe Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 5 Jan 2021 13:43:00 -0500 Subject: [PATCH 3/3] Link to CLI instruction --- docs/overview/roadmap.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index b0c031689d030..6ed4a3272d47f 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -8,9 +8,9 @@ description: Roadmap of Backstage Project > Backstage is currently under rapid development. This means that you can expect > APIs and features to evolve. It is also recommended that teams who adopt -> Backstage today upgrade their installation as new -> [releases](https://github.com/backstage/backstage/releases) become available, -> as Backwards compatibility is not yet guaranteed. +> Backstage today [upgrade their installation](../cli/commands.md#versionsbump) +> as new [releases](https://github.com/backstage/backstage/releases) become +> available, as Backwards compatibility is not yet guaranteed. ## Phases