Merge pull request #2489 from iamrajiv/issue_1994

Added description header field in backstage.io docs

docs/FAQ.md

@@ -1,6 +1,7 @@
 ---
 id: FAQ
 title: FAQ
+description: All FAQ related to Backstage
 ---
 
 ## Product FAQ

docs/api/backend.md

@@ -1,6 +1,7 @@
 ---
 id: backend
 title: Backend
+description: About Backend
 ---
 
 ## TODO

docs/api/utility-apis.md

@@ -1,6 +1,7 @@
 ---
 id: utility-apis
 title: Utility APIs
+description: Backstage Utility APIs
 ---
 
 ## Introduction

docs/architecture-decisions/adr001-add-adr-log.md

@@ -2,6 +2,7 @@
 id: adrs-adr001
 title: ADR001: Architecture Decision Record (ADR) log
 sidebar_label: ADR001
+description: Architecture Decision Record (ADR) logs as a reference point for the team
 ---
 
 | Created    | Status |

docs/architecture-decisions/adr002-default-catalog-file-format.md

@@ -2,6 +2,7 @@
 id: adrs-adr002
 title: ADR002: Default Software Catalog File Format
 sidebar_label: ADR002
+description: Architecture Decision Record (ADR) log on Default Software Catalog File Format
 ---
 
 | Created    | Status |

docs/architecture-decisions/adr003-avoid-default-exports.md

@@ -2,6 +2,7 @@
 id: adrs-adr003
 title: ADR003: Avoid Default Exports and Prefer Named Exports
 sidebar_label: ADR003
+description: Architecture Decision Record (ADR) log on Avoid Default Exports and Prefer Named Exports
 ---
 
 | Created    | Status |

docs/architecture-decisions/adr004-module-export-structure.md

@@ -2,6 +2,7 @@
 id: adrs-adr004
 title: ADR004: Module Export Structure
 sidebar_label: ADR004
+description: Architecture Decision Record (ADR) log on Module Export Structure
 ---
 
 | Created    | Status |

docs/architecture-decisions/adr005-catalog-core-entities.md

@@ -2,6 +2,7 @@
 id: adrs-adr005
 title: ADR005: Catalog Core Entities
 sidebar_label: ADR005
+description: Architecture Decision Record (ADR) log on Catalog Core Entities
 ---
 
 | Created    | Status |

docs/architecture-decisions/adr006-avoid-react-fc.md

@@ -2,6 +2,7 @@
 id: adrs-adr006
 title: ADR006: Avoid React.FC and React.SFC
 sidebar_label: ADR006
+description: Architecture Decision Record (ADR) log on Avoid React.FC and React.SFC
 ---
 
 ## Context

docs/architecture-decisions/adr007-use-msw-to-mock-service-requests.md

@@ -2,6 +2,7 @@
 id: adrs-adr007
 title: ADR007: Use MSW to mock http requests
 sidebar_label: ADR007
+description: Architecture Decision Record (ADR) log on Use MSW to mock http requests
 ---
 
 ## Context

docs/architecture-decisions/adr008-default-catalog-file-name.md

@@ -2,6 +2,7 @@
 id: adrs-adr008
 title: ADR008: Default Catalog File Name
 sidebar_label: ADR008
+description: Architecture Decision Record (ADR) log on Default Catalog File Name
 ---
 
 ## Background

docs/architecture-decisions/index.md

@@ -2,6 +2,7 @@
 id: adrs-overview
 title: Architecture Decision Records (ADR)
 sidebar_label: Overview
+description: Overview of Architecture Decision Records (ADR)
 ---
 
 The substantial architecture decisions made in the Backstage project live here.

docs/auth/add-auth-provider.md

@@ -1,6 +1,7 @@
 ---
 id: add-auth-provider
 title: Adding authentication providers
+description: Documentation on Adding authentication providers
 ---
 
 ## Passport

docs/auth/auth-backend-classes.md

@@ -1,6 +1,7 @@
 ---
 id: auth-backend-classes
 title: Auth backend classes
+description: Documentation on Auth backend classes
 ---
 
 ## How Does Authentication Work?

docs/auth/auth-backend.md

@@ -1,6 +1,7 @@
 ---
 id: auth-backend
 title: Auth backend
+description: Documentation on Auth backend
 ---
 
 ## TODO

docs/auth/glossary.md

@@ -1,6 +1,7 @@
 ---
 id: glossary
 title: Glossary
+description: All Glossaries related to auth
 ---
 
 - **Popup** - A separate browser window opened on top of the previous one.

docs/auth/index.md

@@ -1,6 +1,7 @@
 ---
 id: index
 title: User Authentication and Authorization in Backstage
+description: Documentation on User Authentication and Authorization in Backstage
 ---
 
 ## Summary

docs/auth/oauth.md

@@ -1,6 +1,9 @@
 ---
 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
 ---
 
 This section describes how Backstage allows plugins to request OAuth Access

docs/conf/defining.md

@@ -1,6 +1,7 @@
 ---
 id: defining
 title: Defining Configuration for your Plugin
+description: Documentation on Defining Configuration for your Plugin
 ---
 
 There is currently no tooling support or helpers for defining plugin

docs/conf/index.md

@@ -1,6 +1,7 @@
 ---
 id: index
 title: Static Configuration in Backstage
+description: Documentation on Static Configuration in Backstage
 ---
 
 ## Summary

docs/conf/reading.md

@@ -1,6 +1,7 @@
 ---
 id: reading
 title: Reading Backstage Configuration
+description: Documentation on Reading Backstage Configuration
 ---
 
 ## Config API

docs/conf/writing.md

@@ -1,6 +1,7 @@
 ---
 id: writing
 title: Writing Backstage Configuration Files
+description: Documentation on Writing Backstage Configuration Files
 ---
 
 ## File Format

docs/dls/contributing-to-storybook.md

@@ -1,6 +1,7 @@
 ---
 id: contributing-to-storybook
 title: Contributing to Storybook
+description: Documentation on How to Contribute to Storybook
 ---
 
 You find our storybook at

docs/dls/design.md

@@ -1,6 +1,7 @@
 ---
 id: design
 title: Design
+description: Documentation on Design
 ---
 
 ![header](../assets/dls/designheader-updated.png)

docs/dls/figma.md

@@ -1,6 +1,8 @@
 ---
 id: figma
 title: Figma
+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

docs/features/software-catalog/api.md

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

docs/features/software-catalog/configuration.md

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

docs/features/software-catalog/descriptor-format.md

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

docs/features/software-catalog/extending-the-model.md

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

docs/features/software-catalog/external-integrations.md

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

docs/features/software-catalog/index.md

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

docs/features/software-catalog/installation.md

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

docs/features/software-catalog/system-model.md

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

docs/features/software-catalog/well-known-annotations.md

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

docs/features/software-templates/adding-templates.md

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

docs/features/software-templates/extending/create-your-own-preparer.md

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

docs/features/software-templates/extending/create-your-own-publisher.md

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

docs/features/software-templates/extending/create-your-own-templater.md

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

docs/features/software-templates/index.md

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

docs/features/software-templates/installation.md

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

docs/features/techdocs/FAQ.md

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

docs/features/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?

docs/features/techdocs/architecture.md

@@ -1,6 +1,7 @@
 ---
 id: architecture
 title: Architecture
+description: Documentation on Architecture
 ---
 
 ![TechDocs Big Picture](../../assets/techdocs/techdocs_big_picture.png)

docs/features/techdocs/concepts.md

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

docs/features/techdocs/creating-and-publishing.md

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

docs/features/techdocs/getting-started.md

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

docs/getting-started/app-custom-theme.md

@@ -1,6 +1,7 @@
 ---
 id: app-custom-theme
 title: Customize the look-and-feel of your App
+description: Documentation on Customizing look and feel of the App
 ---
 
 Backstage ships with a default theme with a light and dark mode variant. The

docs/getting-started/configure-app-with-plugins.md

@@ -1,6 +1,7 @@
 ---
 id: configure-app-with-plugins
 title: Configuring App with plugins
+description: Documentation on How Configuring App with plugins
 ---
 
 ## Adding existing plugins to your app

docs/getting-started/create-an-app.md

@@ -1,6 +1,7 @@
 ---
 id: create-an-app
 title: Create an App
+description: Documentation on Creating an App
 ---
 
 To get set up quickly with your own Backstage project you can create a Backstage

docs/getting-started/deployment-k8s.md

@@ -1,6 +1,7 @@
 ---
 id: deployment-k8s
 title: Kubernetes
+description: Documentation on Kubernetes and K8s Deployment
 ---
 
 Coming soon!

docs/getting-started/deployment-other.md

@@ -1,6 +1,7 @@
 ---
 id: deployment-other
 title: Other
+description: Documentation on different ways of Deployment
 ---
 
 ## Deploying Locally

docs/getting-started/development-environment.md

@@ -1,6 +1,8 @@
 ---
 id: development-environment
 title: Development Environment
+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

docs/getting-started/index.md

@@ -1,6 +1,7 @@
 ---
 id: index
 title: Getting Started
+description: Documentation on How to get started with Backstage
 ---
 
 There are two different ways to get started with Backstage, either by creating a

docs/getting-started/installation.md

@@ -1,6 +1,7 @@
 ---
 id: installation
 title: Installation
+description: Documentation on Installation
 ---
 
 Coming soon!

docs/getting-started/running-backstage-locally.md

@@ -1,6 +1,7 @@
 ---
 id: running-backstage-locally
 title: Running Backstage Locally
+description: Documentation on How to run Backstage Locally
 ---
 
 ## Prerequisites

docs/overview/adopting.md

@@ -1,6 +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
 ---
 
 This document outlines some general best practices that have been key to

docs/overview/architecture-overview.md

@@ -1,6 +1,7 @@
 ---
 id: architecture-overview
 title: Architecture overview
+description: Documentation on Architecture overview
 ---
 
 ## Overview

docs/overview/architecture-terminology.md

@@ -1,6 +1,7 @@
 ---
 id: architecture-terminology
 title: Architecture terminology
+description: Documentation on Architecture terminology
 ---
 
 Backstage is constructed out of three parts. We separate Backstage in this way

docs/overview/background.md

@@ -1,6 +1,7 @@
 ---
 id: background
 title: The Spotify Story
+description: Documentation on Background and Story behind making of Backstage
 ---
 
 Backstage was born out of necessity at Spotify. We found that as we grew, our

docs/overview/logos.md

@@ -2,6 +2,7 @@
 id: logos
 title: Logos
 sidebar_label: Logo assets
+description: Guidelines for how to use the Backstage logos and icons
 ---
 
 Guidelines for how to use the Backstage logo and icon can be found

docs/overview/roadmap.md

@@ -1,6 +1,7 @@
 ---
 id: roadmap
 title: Project roadmap
+description: Roadmap of Backstage Project
 ---
 
 ## Current status

docs/overview/support.md

@@ -1,6 +1,7 @@
 ---
 id: support
 title: Support and community
+description: Support and Community Details and Links
 ---
 
 - [Discord chatroom](https://discord.gg/MUpMjP2) - Get support or discuss the

docs/overview/vision.md

@@ -1,6 +1,8 @@
 ---
 id: vision
 title: Vision
+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

docs/overview/what-is-backstage.md

@@ -1,6 +1,8 @@
 ---
 id: what-is-backstage
 title: What is Backstage?
+description: Backsatge 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)

docs/plugins/add-to-marketplace.md

@@ -1,6 +1,7 @@
 ---
 id: add-to-marketplace
 title: Add to Marketplace
+description: Documentation on Adding Plugin to Marketplace
 ---
 
 ## Adding a Plugin to the Marketplace

docs/plugins/backend-plugin.md

@@ -1,6 +1,7 @@
 ---
 id: backend-plugin
 title: Backend plugin
+description: Documentation on Backend plugin
 ---
 
 ## TODO

docs/plugins/call-existing-api.md

@@ -1,6 +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
 ---
 
 This article describes the various options that Backstage frontend plugins have,

docs/plugins/create-a-plugin.md

@@ -1,6 +1,7 @@
 ---
 id: create-a-plugin
 title: Create a Backstage Plugin
+description: Documentation on How to Create a Backstage Plugin
 ---
 
 A Backstage Plugin adds functionality to Backstage.

docs/plugins/existing-plugins.md

@@ -1,6 +1,7 @@
 ---
 id: existing-plugins
 title: Existing plugins
+description: Lists of existing open source plugins
 ---
 
 ## Open source plugins

docs/plugins/index.md

@@ -1,6 +1,7 @@
 ---
 id: index
 title: Intro to plugins
+description: Documentation on Introduction to Plugins
 ---
 
 Backstage is a single-page application composed of a set of plugins.

docs/plugins/integrating-plugin-into-service-catalog.md

@@ -1,6 +1,7 @@
 ---
 id: integrating-plugin-into-service-catalog
 title: Integrate into the Service Catalog
+description: Documentation on How to integrate plugin into service catalog
 ---
 
 > This is an advanced use case and currently is an experimental feature. Expect

docs/plugins/plugin-development.md

@@ -1,6 +1,7 @@
 ---
 id: plugin-development
 title: Plugin Development
+description: Documentation on Plugin Development
 ---
 
 Backstage plugins provide features to a Backstage App.

docs/plugins/proxying.md

@@ -1,6 +1,7 @@
 ---
 id: proxying
 title: Proxying
+description: Documentation on Proxying
 ---
 
 ## Overview

docs/plugins/publish-private.md

@@ -1,6 +1,7 @@
 ---
 id: publish-private
 title: Publish private
+description: Documentation on How to Publish private
 ---
 
 ## TODO

docs/plugins/publishing.md

@@ -1,6 +1,7 @@
 ---
 id: publishing
 title: Publishing
+description: Documentation on Publishing NPM packages
 ---
 
 ## NPM

docs/plugins/structure-of-a-plugin.md

@@ -1,6 +1,7 @@
 ---
 id: structure-of-a-plugin
 title: Structure of a Plugin
+description: Details about structure of a plugin
 ---
 
 Nice, you have a new plugin! We'll soon see how we can develop it into doing

docs/plugins/testing.md

@@ -1,6 +1,7 @@
 ---
 id: testing
 title: Testing with Jest
+description: Documentation on How to do unit testing with Jest
 ---
 
 Backstage uses [Jest](https://facebook.github.io/jest/) for all our unit testing

docs/reference/createPlugin-feature-flags.md

@@ -1,6 +1,7 @@
 ---
 id: createPlugin-feature-flags
 title: createPlugin - feature flags
+description: Documentation on createPlugin - feature flags
 ---
 
 The `featureFlags` object passed to the `register` function makes it possible

docs/reference/createPlugin-router.md

@@ -1,6 +1,7 @@
 ---
 id: createPlugin-router
 title: createPlugin - router
+description: Documentation on createPlugin - router
 ---
 
 The router that is passed to the `register` function makes it possible for

docs/reference/createPlugin.md

@@ -1,6 +1,7 @@
 ---
 id: createPlugin
 title: createPlugin
+description: Documentation on createPlugin
 ---
 
 Taking a plugin config as argument and returns a new plugin.

docs/tutorials/journey.md

@@ -1,6 +1,7 @@
 ---
 id: journey
 title: Future developer journey
+description: This document describes a possible journey of a future Backstage
 ---
 
 > This document describes a possible journey of a **_future_** Backstage plugin