Merge pull request #3927 from adamdmharvey/doco-prettier-seo

docs: Align Docusaurus for fixed SEO output and "prettier" happiness
2021-01-12 21:42:53 +01:00
parent 04ad0ec380 a823f2bc40
commit ffa36ff101
16 changed files with 32 additions and 34 deletions
@@ -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
@@ -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
@@ -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

@@ -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
@@ -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
@@ -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)