Merge pull request #2489 from iamrajiv/issue_1994

Added description header field in backstage.io docs
2020-09-16 22:29:50 +02:00
parent 19550ef1fd 485fa981d2
commit b0656e47d9
81 changed files with 97 additions and 0 deletions
@@ -1,6 +1,7 @@
 ---
 id: software-catalog-api
 title: API
+description: Documentation on Software Catalog API
 ---

 ## TODO
@@ -1,6 +1,7 @@
 ---
 id: software-catalog-configuration
 title: Catalog Configuration
+description: Documentation on Software Catalog Configuration
 ---

 ## Static Location Configuration
@@ -2,6 +2,8 @@
 id: descriptor-format
 title: Descriptor Format of Catalog Entities
 sidebar_label: YAML File Format
+description: Documentation on Descriptor Format of Catalog Entities which
+describes the default data shape and semantics of catalog entities
 ---

 This section describes the default data shape and semantics of catalog entities.
@@ -1,6 +1,7 @@
 ---
 id: extending-the-model
 title: Extending the model
+description: Documentation on Extending the model
 ---

 Backstage natively supports tracking of the following component
@@ -1,6 +1,8 @@
 ---
 id: external-integrations
 title: External integrations
+description: Documentation on External integrations to integrate systems
+with Backstage
 ---

 Backstage natively supports storing software components in
@@ -2,6 +2,8 @@
 id: software-catalog-overview
 title: Backstage Service Catalog (alpha)
 sidebar_label: Overview
+description: The Backstage Service Catalog — actually, a software catalog, since
+it includes more than just services
 ---

 ## What is a Service Catalog?
@@ -1,6 +1,7 @@
 ---
 id: installation
 title: Installing in your Backstage App
+description: Documentation on How to install Backstage Plugin
 ---

 The catalog plugin comes in two packages, `@backstage/plugin-catalog` and
@@ -1,6 +1,7 @@
 ---
 id: system-model
 title: System Model
+description: Documentation on System Model
 ---

 We believe that a strong shared understanding and terminology around software
@@ -2,6 +2,9 @@
 id: well-known-annotations
 title: Well-known Annotations on Catalog Entities
 sidebar_label: Well-known Annotations
+description: Documentation on lists a number of well known Annotations, that
+have defined semantics. They can be attached to catalog entities and consumed
+by plugins as needed
 ---

 This section lists a number of well known
@@ -1,6 +1,7 @@
 ---
 id: adding-templates
 title: Adding your own Templates
+description: Documentation on Adding your own Templates
 ---

 Templates are stored in the **Service Catalog** under a kind `Template`. The
@@ -1,6 +1,7 @@
 ---
 id: extending-preparer
 title: Create your own Preparer
+description: Documentation on Creating your own Preparer
 ---

 Preparers are responsible for reading the location of the definition of a
@@ -1,6 +1,7 @@
 ---
 id: extending-publisher
 title: Create your own Publisher
+description: Documentation on Creating your own Publisher
 ---

 Publishers are responsible for pushing and storing the templated skeleton after
@@ -1,6 +1,7 @@
 ---
 id: extending-templater
 title: Creating your own Templater
+description: Documentation on Creating your own Templater
 ---

 Templaters are responsible for taking the directory path for the skeleton
@@ -2,6 +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
 ---

 The Software Templates part of Backstage is a tool that can help you create
@@ -1,6 +1,7 @@
 ---
 id: installation
 title: Installing in your Backstage App
+description: Documentation on How to install Backstage App
 ---

 The scaffolder plugin comes in two packages, `@backstage/plugin-scaffolder` and
@@ -2,6 +2,7 @@
 id: faqs
 title: TechDocs FAQ
 sidebar_label: FAQ
+description: This page answers frequently asked questions about TechDocs
 ---

 This page answers frequently asked questions about [TechDocs](README.md).
@@ -2,6 +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
 ---

 ## What is it?
@@ -1,6 +1,7 @@
 ---
 id: architecture
 title: Architecture
+description: Documentation on Architecture
 ---

 ![TechDocs Big Picture](../../assets/techdocs/techdocs_big_picture.png)
@@ -1,6 +1,8 @@
 ---
 id: concepts
 title: Concepts
+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
@@ -2,6 +2,7 @@
 id: creating-and-publishing
 title: Creating and publishing your docs
 sidebar_label: Creating and Publishing Documentation
+description: Guidance on how to create and publish documentation
 ---

 This section will guide you through:
@@ -1,6 +1,7 @@
 ---
 id: getting-started
 title: Getting Started
+description: Getting Started Guidelines
 ---

 TechDocs functions as a plugin to Backstage, so you will need to use Backstage