From def4032351c6e92a33ab824cb4373b5e9a7949c3 Mon Sep 17 00:00:00 2001 From: Rajiv Ranjan Singh Date: Wed, 16 Sep 2020 21:47:19 +0530 Subject: [PATCH] added description header field --- docs/FAQ.md | 1 + docs/api/backend.md | 1 + docs/api/utility-apis.md | 1 + docs/architecture-decisions/adr001-add-adr-log.md | 1 + .../adr002-default-catalog-file-format.md | 1 + docs/architecture-decisions/adr003-avoid-default-exports.md | 1 + docs/architecture-decisions/adr004-module-export-structure.md | 1 + docs/architecture-decisions/adr005-catalog-core-entities.md | 1 + docs/architecture-decisions/adr006-avoid-react-fc.md | 1 + .../adr007-use-msw-to-mock-service-requests.md | 1 + docs/architecture-decisions/adr008-default-catalog-file-name.md | 1 + docs/architecture-decisions/index.md | 1 + docs/auth/add-auth-provider.md | 1 + docs/auth/auth-backend-classes.md | 1 + docs/auth/auth-backend.md | 1 + docs/auth/glossary.md | 1 + docs/auth/index.md | 1 + docs/auth/oauth.md | 2 ++ docs/conf/defining.md | 1 + docs/conf/index.md | 1 + docs/conf/reading.md | 1 + docs/conf/writing.md | 1 + docs/dls/contributing-to-storybook.md | 1 + docs/dls/design.md | 1 + docs/dls/figma.md | 1 + docs/features/software-catalog/api.md | 1 + docs/features/software-catalog/configuration.md | 1 + docs/features/software-catalog/descriptor-format.md | 1 + docs/features/software-catalog/extending-the-model.md | 1 + docs/features/software-catalog/external-integrations.md | 1 + docs/features/software-catalog/index.md | 2 ++ docs/features/software-catalog/installation.md | 1 + docs/features/software-catalog/system-model.md | 1 + docs/features/software-catalog/well-known-annotations.md | 1 + docs/features/software-templates/adding-templates.md | 1 + .../software-templates/extending/create-your-own-preparer.md | 1 + .../software-templates/extending/create-your-own-publisher.md | 1 + .../software-templates/extending/create-your-own-templater.md | 1 + docs/features/software-templates/index.md | 1 + docs/features/software-templates/installation.md | 1 + docs/features/techdocs/FAQ.md | 1 + docs/features/techdocs/README.md | 1 + docs/features/techdocs/architecture.md | 1 + docs/features/techdocs/concepts.md | 1 + docs/features/techdocs/creating-and-publishing.md | 1 + docs/features/techdocs/getting-started.md | 1 + docs/getting-started/app-custom-theme.md | 1 + docs/getting-started/configure-app-with-plugins.md | 1 + docs/getting-started/create-an-app.md | 1 + docs/getting-started/deployment-k8s.md | 1 + docs/getting-started/deployment-other.md | 1 + docs/getting-started/development-environment.md | 1 + docs/getting-started/index.md | 1 + docs/getting-started/installation.md | 1 + docs/getting-started/running-backstage-locally.md | 1 + docs/overview/adopting.md | 2 ++ docs/overview/architecture-overview.md | 1 + docs/overview/architecture-terminology.md | 1 + docs/overview/background.md | 1 + docs/overview/logos.md | 1 + docs/overview/roadmap.md | 1 + docs/overview/support.md | 1 + docs/overview/vision.md | 1 + docs/overview/what-is-backstage.md | 1 + docs/plugins/add-to-marketplace.md | 1 + docs/plugins/backend-plugin.md | 1 + docs/plugins/call-existing-api.md | 2 ++ docs/plugins/create-a-plugin.md | 1 + docs/plugins/existing-plugins.md | 1 + docs/plugins/index.md | 1 + docs/plugins/integrating-plugin-into-service-catalog.md | 1 + docs/plugins/plugin-development.md | 1 + docs/plugins/proxying.md | 1 + docs/plugins/publish-private.md | 1 + docs/plugins/publishing.md | 1 + docs/plugins/structure-of-a-plugin.md | 1 + docs/plugins/testing.md | 1 + docs/reference/createPlugin-feature-flags.md | 1 + docs/reference/createPlugin-router.md | 1 + docs/reference/createPlugin.md | 1 + docs/tutorials/journey.md | 1 + 81 files changed, 85 insertions(+) diff --git a/docs/FAQ.md b/docs/FAQ.md index 4b5df3ace0..b4c4970ff8 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,6 +1,7 @@ --- id: FAQ title: FAQ +description: All FAQ related to Backstage --- ## Product FAQ diff --git a/docs/api/backend.md b/docs/api/backend.md index bc44b8350c..0990343a01 100644 --- a/docs/api/backend.md +++ b/docs/api/backend.md @@ -1,6 +1,7 @@ --- id: backend title: Backend +description: About Backend --- ## TODO diff --git a/docs/api/utility-apis.md b/docs/api/utility-apis.md index 37cde87262..d192cbd6ee 100644 --- a/docs/api/utility-apis.md +++ b/docs/api/utility-apis.md @@ -1,6 +1,7 @@ --- id: utility-apis title: Utility APIs +description: Backstage Utility APIs --- ## Introduction diff --git a/docs/architecture-decisions/adr001-add-adr-log.md b/docs/architecture-decisions/adr001-add-adr-log.md index 8a484fa264..eef5f62820 100644 --- a/docs/architecture-decisions/adr001-add-adr-log.md +++ b/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 | diff --git a/docs/architecture-decisions/adr002-default-catalog-file-format.md b/docs/architecture-decisions/adr002-default-catalog-file-format.md index af22d33020..da98aafaed 100644 --- a/docs/architecture-decisions/adr002-default-catalog-file-format.md +++ b/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 | diff --git a/docs/architecture-decisions/adr003-avoid-default-exports.md b/docs/architecture-decisions/adr003-avoid-default-exports.md index 7a8df28f49..9d1f9c83a4 100644 --- a/docs/architecture-decisions/adr003-avoid-default-exports.md +++ b/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 | diff --git a/docs/architecture-decisions/adr004-module-export-structure.md b/docs/architecture-decisions/adr004-module-export-structure.md index 077f8c35d1..3dbda3f8b9 100644 --- a/docs/architecture-decisions/adr004-module-export-structure.md +++ b/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 | diff --git a/docs/architecture-decisions/adr005-catalog-core-entities.md b/docs/architecture-decisions/adr005-catalog-core-entities.md index 8f39acd1cf..ae615f647d 100644 --- a/docs/architecture-decisions/adr005-catalog-core-entities.md +++ b/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 | diff --git a/docs/architecture-decisions/adr006-avoid-react-fc.md b/docs/architecture-decisions/adr006-avoid-react-fc.md index e48fceb562..696cdcf537 100644 --- a/docs/architecture-decisions/adr006-avoid-react-fc.md +++ b/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 diff --git a/docs/architecture-decisions/adr007-use-msw-to-mock-service-requests.md b/docs/architecture-decisions/adr007-use-msw-to-mock-service-requests.md index 773f08be30..d91af19068 100644 --- a/docs/architecture-decisions/adr007-use-msw-to-mock-service-requests.md +++ b/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 diff --git a/docs/architecture-decisions/adr008-default-catalog-file-name.md b/docs/architecture-decisions/adr008-default-catalog-file-name.md index 979ea4de33..01afefd690 100644 --- a/docs/architecture-decisions/adr008-default-catalog-file-name.md +++ b/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 diff --git a/docs/architecture-decisions/index.md b/docs/architecture-decisions/index.md index 0e9ff21812..dfdbeb0849 100644 --- a/docs/architecture-decisions/index.md +++ b/docs/architecture-decisions/index.md @@ -2,6 +2,7 @@ id: adrs-overview title: Architecture Decision Records (ADR) sidebar_label: Overview +description: --- The substantial architecture decisions made in the Backstage project live here. diff --git a/docs/auth/add-auth-provider.md b/docs/auth/add-auth-provider.md index 7e4f5c8e2f..c5f7645a49 100644 --- a/docs/auth/add-auth-provider.md +++ b/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 diff --git a/docs/auth/auth-backend-classes.md b/docs/auth/auth-backend-classes.md index 0147c66dd9..4ccee8ede9 100644 --- a/docs/auth/auth-backend-classes.md +++ b/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? diff --git a/docs/auth/auth-backend.md b/docs/auth/auth-backend.md index 579d2e2cda..6d8b95ac9f 100644 --- a/docs/auth/auth-backend.md +++ b/docs/auth/auth-backend.md @@ -1,6 +1,7 @@ --- id: auth-backend title: Auth backend +description: Documentation on Auth backend --- ## TODO diff --git a/docs/auth/glossary.md b/docs/auth/glossary.md index 607326b3a5..ad7ae78d19 100644 --- a/docs/auth/glossary.md +++ b/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. diff --git a/docs/auth/index.md b/docs/auth/index.md index b885db0820..0fa8de3280 100644 --- a/docs/auth/index.md +++ b/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 diff --git a/docs/auth/oauth.md b/docs/auth/oauth.md index b7013a310d..a6e2ce7269 100644 --- a/docs/auth/oauth.md +++ b/docs/auth/oauth.md @@ -1,6 +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. --- This section describes how Backstage allows plugins to request OAuth Access diff --git a/docs/conf/defining.md b/docs/conf/defining.md index b28d6b8362..bea03e4e44 100644 --- a/docs/conf/defining.md +++ b/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 diff --git a/docs/conf/index.md b/docs/conf/index.md index bc1d7e8e1f..83eff50a7d 100644 --- a/docs/conf/index.md +++ b/docs/conf/index.md @@ -1,6 +1,7 @@ --- id: index title: Static Configuration in Backstage +description: Documentation on Static Configuration in Backstage --- ## Summary diff --git a/docs/conf/reading.md b/docs/conf/reading.md index 76d1f7f6ea..a43ec8c026 100644 --- a/docs/conf/reading.md +++ b/docs/conf/reading.md @@ -1,6 +1,7 @@ --- id: reading title: Reading Backstage Configuration +description: Documentation on Reading Backstage Configuration --- ## Config API diff --git a/docs/conf/writing.md b/docs/conf/writing.md index da2a10a86d..6d338e586d 100644 --- a/docs/conf/writing.md +++ b/docs/conf/writing.md @@ -1,6 +1,7 @@ --- id: writing title: Writing Backstage Configuration Files +description: Documentation on Writing Backstage Configuration Files --- ## File Format diff --git a/docs/dls/contributing-to-storybook.md b/docs/dls/contributing-to-storybook.md index f0c2201a98..058f4a23a7 100644 --- a/docs/dls/contributing-to-storybook.md +++ b/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 diff --git a/docs/dls/design.md b/docs/dls/design.md index b434fc8791..1f83c2b644 100644 --- a/docs/dls/design.md +++ b/docs/dls/design.md @@ -1,6 +1,7 @@ --- id: design title: Design +description: Documentation on Design --- ![header](../assets/dls/designheader-updated.png) diff --git a/docs/dls/figma.md b/docs/dls/figma.md index 14de2f5980..b4cbead246 100644 --- a/docs/dls/figma.md +++ b/docs/dls/figma.md @@ -1,6 +1,7 @@ --- 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 diff --git a/docs/features/software-catalog/api.md b/docs/features/software-catalog/api.md index 332c1e505b..f7c7b19112 100644 --- a/docs/features/software-catalog/api.md +++ b/docs/features/software-catalog/api.md @@ -1,6 +1,7 @@ --- id: software-catalog-api title: API +description: Documentation on Software Catalog API --- ## TODO diff --git a/docs/features/software-catalog/configuration.md b/docs/features/software-catalog/configuration.md index be6314e494..0bcfaabe0a 100644 --- a/docs/features/software-catalog/configuration.md +++ b/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 diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index fa4b8c23da..6491e96516 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -2,6 +2,7 @@ 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. diff --git a/docs/features/software-catalog/extending-the-model.md b/docs/features/software-catalog/extending-the-model.md index 8b621f2e44..4e8a357ea7 100644 --- a/docs/features/software-catalog/extending-the-model.md +++ b/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 diff --git a/docs/features/software-catalog/external-integrations.md b/docs/features/software-catalog/external-integrations.md index 7ca869cdae..a035df0adc 100644 --- a/docs/features/software-catalog/external-integrations.md +++ b/docs/features/software-catalog/external-integrations.md @@ -1,6 +1,7 @@ --- id: external-integrations title: External integrations +description: Documentation on External integrations to integrate systems with Backstage --- Backstage natively supports storing software components in diff --git a/docs/features/software-catalog/index.md b/docs/features/software-catalog/index.md index 9b5de16472..097988e48e 100644 --- a/docs/features/software-catalog/index.md +++ b/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 — is a centralized system that keeps track of ownership and metadata for all the software in your ecosystem (services, websites, +libraries, data pipelines, etc) --- ## What is a Service Catalog? diff --git a/docs/features/software-catalog/installation.md b/docs/features/software-catalog/installation.md index 85598a2025..a825020eb6 100644 --- a/docs/features/software-catalog/installation.md +++ b/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 diff --git a/docs/features/software-catalog/system-model.md b/docs/features/software-catalog/system-model.md index 4436f60fc2..44dac13d65 100644 --- a/docs/features/software-catalog/system-model.md +++ b/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 diff --git a/docs/features/software-catalog/well-known-annotations.md b/docs/features/software-catalog/well-known-annotations.md index 18de63d704..4bf6ddd719 100644 --- a/docs/features/software-catalog/well-known-annotations.md +++ b/docs/features/software-catalog/well-known-annotations.md @@ -2,6 +2,7 @@ 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 diff --git a/docs/features/software-templates/adding-templates.md b/docs/features/software-templates/adding-templates.md index 1472986c2a..fad5c68e41 100644 --- a/docs/features/software-templates/adding-templates.md +++ b/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 diff --git a/docs/features/software-templates/extending/create-your-own-preparer.md b/docs/features/software-templates/extending/create-your-own-preparer.md index 0b3fb31323..14c75b0ffb 100644 --- a/docs/features/software-templates/extending/create-your-own-preparer.md +++ b/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 diff --git a/docs/features/software-templates/extending/create-your-own-publisher.md b/docs/features/software-templates/extending/create-your-own-publisher.md index 111125b49f..25d7bcf676 100644 --- a/docs/features/software-templates/extending/create-your-own-publisher.md +++ b/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 diff --git a/docs/features/software-templates/extending/create-your-own-templater.md b/docs/features/software-templates/extending/create-your-own-templater.md index 9dee66af06..36c362b9c3 100644 --- a/docs/features/software-templates/extending/create-your-own-templater.md +++ b/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 diff --git a/docs/features/software-templates/index.md b/docs/features/software-templates/index.md index 86493c0120..2a1fbf981e 100644 --- a/docs/features/software-templates/index.md +++ b/docs/features/software-templates/index.md @@ -2,6 +2,7 @@ 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 diff --git a/docs/features/software-templates/installation.md b/docs/features/software-templates/installation.md index eea78e3571..3a51014864 100644 --- a/docs/features/software-templates/installation.md +++ b/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 diff --git a/docs/features/techdocs/FAQ.md b/docs/features/techdocs/FAQ.md index cae0288889..5d6c9136d9 100644 --- a/docs/features/techdocs/FAQ.md +++ b/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). diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index 03f3d452f4..dc9879df29 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -2,6 +2,7 @@ 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? diff --git a/docs/features/techdocs/architecture.md b/docs/features/techdocs/architecture.md index 4e063a8559..926ec238e1 100644 --- a/docs/features/techdocs/architecture.md +++ b/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) diff --git a/docs/features/techdocs/concepts.md b/docs/features/techdocs/concepts.md index 8f5558c0f8..29b3d1a520 100644 --- a/docs/features/techdocs/concepts.md +++ b/docs/features/techdocs/concepts.md @@ -1,6 +1,7 @@ --- 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 diff --git a/docs/features/techdocs/creating-and-publishing.md b/docs/features/techdocs/creating-and-publishing.md index 9d93eda9bc..b48133d627 100644 --- a/docs/features/techdocs/creating-and-publishing.md +++ b/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: diff --git a/docs/features/techdocs/getting-started.md b/docs/features/techdocs/getting-started.md index 174894b020..d8c836c970 100644 --- a/docs/features/techdocs/getting-started.md +++ b/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 diff --git a/docs/getting-started/app-custom-theme.md b/docs/getting-started/app-custom-theme.md index e555c6b52d..97876c2ba1 100644 --- a/docs/getting-started/app-custom-theme.md +++ b/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 diff --git a/docs/getting-started/configure-app-with-plugins.md b/docs/getting-started/configure-app-with-plugins.md index 515b52afa7..1d02f147c1 100644 --- a/docs/getting-started/configure-app-with-plugins.md +++ b/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 diff --git a/docs/getting-started/create-an-app.md b/docs/getting-started/create-an-app.md index cebf3f5de2..452e90add5 100644 --- a/docs/getting-started/create-an-app.md +++ b/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 diff --git a/docs/getting-started/deployment-k8s.md b/docs/getting-started/deployment-k8s.md index 2a184779e2..ddcbd290c6 100644 --- a/docs/getting-started/deployment-k8s.md +++ b/docs/getting-started/deployment-k8s.md @@ -1,6 +1,7 @@ --- id: deployment-k8s title: Kubernetes +description: Documentation on Kubernetes and K8s Deployment --- Coming soon! diff --git a/docs/getting-started/deployment-other.md b/docs/getting-started/deployment-other.md index d3fb9d932b..2cd9708e2a 100644 --- a/docs/getting-started/deployment-other.md +++ b/docs/getting-started/deployment-other.md @@ -1,6 +1,7 @@ --- id: deployment-other title: Other +description: Documentation on different ways of Deployment --- ## Deploying Locally diff --git a/docs/getting-started/development-environment.md b/docs/getting-started/development-environment.md index 9c75c8eabf..f1399c3c1a 100644 --- a/docs/getting-started/development-environment.md +++ b/docs/getting-started/development-environment.md @@ -1,6 +1,7 @@ --- 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 diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index c528ad34ad..a9ac770f90 100644 --- a/docs/getting-started/index.md +++ b/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 diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index a4f91b6e95..3b11d2b8e1 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -1,6 +1,7 @@ --- id: installation title: Installation +description: Documentation on Installation --- Coming soon! diff --git a/docs/getting-started/running-backstage-locally.md b/docs/getting-started/running-backstage-locally.md index 08d2ab385b..b784c52bf3 100644 --- a/docs/getting-started/running-backstage-locally.md +++ b/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 --- First make sure you are using NodeJS with an Active LTS Release, currently v12. diff --git a/docs/overview/adopting.md b/docs/overview/adopting.md index 893eac6398..96f7a614d2 100644 --- a/docs/overview/adopting.md +++ b/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 diff --git a/docs/overview/architecture-overview.md b/docs/overview/architecture-overview.md index 55a1aeec04..f2c6dad61f 100644 --- a/docs/overview/architecture-overview.md +++ b/docs/overview/architecture-overview.md @@ -1,6 +1,7 @@ --- id: architecture-overview title: Architecture overview +description: Documentation on Architecture overview --- ## Overview diff --git a/docs/overview/architecture-terminology.md b/docs/overview/architecture-terminology.md index aee581f927..092ca7fb01 100644 --- a/docs/overview/architecture-terminology.md +++ b/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 diff --git a/docs/overview/background.md b/docs/overview/background.md index ef226653fb..486260bac3 100644 --- a/docs/overview/background.md +++ b/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 diff --git a/docs/overview/logos.md b/docs/overview/logos.md index 39071ed793..2a684420bc 100644 --- a/docs/overview/logos.md +++ b/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 diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 5a06f4544f..d6c1d2d641 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -1,6 +1,7 @@ --- id: roadmap title: Project roadmap +description: Roadmap of Backstage Project --- ## Current status diff --git a/docs/overview/support.md b/docs/overview/support.md index 9e4e9eca15..6e00c17fab 100644 --- a/docs/overview/support.md +++ b/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 diff --git a/docs/overview/vision.md b/docs/overview/vision.md index 2ab7cdc6f4..f6e389e245 100644 --- a/docs/overview/vision.md +++ b/docs/overview/vision.md @@ -1,6 +1,7 @@ --- 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 diff --git a/docs/overview/what-is-backstage.md b/docs/overview/what-is-backstage.md index 96e89618a8..0deba70d73 100644 --- a/docs/overview/what-is-backstage.md +++ b/docs/overview/what-is-backstage.md @@ -1,6 +1,7 @@ --- 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) diff --git a/docs/plugins/add-to-marketplace.md b/docs/plugins/add-to-marketplace.md index d85807a226..59cca07bff 100644 --- a/docs/plugins/add-to-marketplace.md +++ b/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 diff --git a/docs/plugins/backend-plugin.md b/docs/plugins/backend-plugin.md index 986af66c20..516ba4b111 100644 --- a/docs/plugins/backend-plugin.md +++ b/docs/plugins/backend-plugin.md @@ -1,6 +1,7 @@ --- id: backend-plugin title: Backend plugin +description: Documentation on Backend plugin --- ## TODO diff --git a/docs/plugins/call-existing-api.md b/docs/plugins/call-existing-api.md index 9658176224..14ea4c1f5a 100644 --- a/docs/plugins/call-existing-api.md +++ b/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, diff --git a/docs/plugins/create-a-plugin.md b/docs/plugins/create-a-plugin.md index 4bcc4da387..bcb86024fd 100644 --- a/docs/plugins/create-a-plugin.md +++ b/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. diff --git a/docs/plugins/existing-plugins.md b/docs/plugins/existing-plugins.md index 8598ae02c4..01460b8101 100644 --- a/docs/plugins/existing-plugins.md +++ b/docs/plugins/existing-plugins.md @@ -1,6 +1,7 @@ --- id: existing-plugins title: Existing plugins +description: Lists of open source Existing plugins --- ## Open source plugins diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 5aaf8acadf..8a61aeee80 100644 --- a/docs/plugins/index.md +++ b/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. diff --git a/docs/plugins/integrating-plugin-into-service-catalog.md b/docs/plugins/integrating-plugin-into-service-catalog.md index 4408c27ccc..51d2331140 100644 --- a/docs/plugins/integrating-plugin-into-service-catalog.md +++ b/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 diff --git a/docs/plugins/plugin-development.md b/docs/plugins/plugin-development.md index faf3c6ddbd..c5d9763f7d 100644 --- a/docs/plugins/plugin-development.md +++ b/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. diff --git a/docs/plugins/proxying.md b/docs/plugins/proxying.md index 1951f41763..2f809ffd10 100644 --- a/docs/plugins/proxying.md +++ b/docs/plugins/proxying.md @@ -1,6 +1,7 @@ --- id: proxying title: Proxying +description: Documentation on Proxying --- ## Overview diff --git a/docs/plugins/publish-private.md b/docs/plugins/publish-private.md index 6361f70854..d04449d465 100644 --- a/docs/plugins/publish-private.md +++ b/docs/plugins/publish-private.md @@ -1,6 +1,7 @@ --- id: publish-private title: Publish private +description: Documentation on How to Publish private --- ## TODO diff --git a/docs/plugins/publishing.md b/docs/plugins/publishing.md index 6fee4f9b1d..0ed85e8cdc 100644 --- a/docs/plugins/publishing.md +++ b/docs/plugins/publishing.md @@ -1,6 +1,7 @@ --- id: publishing title: Publishing +description: Documentation on Publishing NPM packages --- ## NPM diff --git a/docs/plugins/structure-of-a-plugin.md b/docs/plugins/structure-of-a-plugin.md index 20e72c539d..c93815ecd2 100644 --- a/docs/plugins/structure-of-a-plugin.md +++ b/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 diff --git a/docs/plugins/testing.md b/docs/plugins/testing.md index 110bc97515..696f8b1368 100644 --- a/docs/plugins/testing.md +++ b/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 diff --git a/docs/reference/createPlugin-feature-flags.md b/docs/reference/createPlugin-feature-flags.md index bc38656939..ebb8a6b503 100644 --- a/docs/reference/createPlugin-feature-flags.md +++ b/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 diff --git a/docs/reference/createPlugin-router.md b/docs/reference/createPlugin-router.md index 361b485df9..89ee44e558 100644 --- a/docs/reference/createPlugin-router.md +++ b/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 diff --git a/docs/reference/createPlugin.md b/docs/reference/createPlugin.md index 0cabe63b39..45e3303124 100644 --- a/docs/reference/createPlugin.md +++ b/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. diff --git a/docs/tutorials/journey.md b/docs/tutorials/journey.md index 3c399c53ba..ea3e17446a 100644 --- a/docs/tutorials/journey.md +++ b/docs/tutorials/journey.md @@ -1,6 +1,7 @@ --- id: journey title: Future developer journey +description: Document describes a possible journey of a future Backstage plugin developer --- > This document describes a possible journey of a **_future_** Backstage plugin