Merge pull request #29899 from awanlin/docs/remove-prettier-ignore-comment

Removed unneeded `# prettier-ignore` comment in docs and blog files
This commit is contained in:
Andre Wanlin
2025-06-11 08:50:59 -05:00
committed by GitHub
141 changed files with 18 additions and 159 deletions
@@ -1,7 +1,6 @@
---
id: adrs-adr000
title: 'ADR000: [TITLE]'
# prettier-ignore
description: Architecture Decision Record (ADR) for [TITLE] [DESCRIPTION]
---
@@ -1,7 +1,6 @@
---
id: adrs-adr001
title: 'ADR001: Architecture Decision Record (ADR) log'
# prettier-ignore
description: Architecture Decision Record (ADR) logs as a reference point for the team
---
@@ -1,7 +1,6 @@
---
id: adrs-adr002
title: 'ADR002: Default Software Catalog File Format'
# prettier-ignore
description: Architecture Decision Record (ADR) log on Default Software Catalog File Format
---
@@ -1,7 +1,6 @@
---
id: adrs-adr003
title: 'ADR003: Avoid Default Exports and Prefer Named Exports'
# prettier-ignore
description: Architecture Decision Record (ADR) log on Avoid Default Exports and Prefer Named Exports
---
@@ -1,7 +1,6 @@
---
id: adrs-adr004
title: 'ADR004: Module Export Structure'
# prettier-ignore
description: Architecture Decision Record (ADR) log on Module Export Structure
---
@@ -1,7 +1,6 @@
---
id: adrs-adr005
title: 'ADR005: Catalog Core Entities'
# prettier-ignore
description: Architecture Decision Record (ADR) log on Catalog Core Entities
---
@@ -1,7 +1,6 @@
---
id: adrs-adr006
title: 'ADR006: Avoid React.FC and React.SFC'
# prettier-ignore
description: Architecture Decision Record (ADR) log on Avoid React.FC and React.SFC
---
@@ -1,7 +1,6 @@
---
id: adrs-adr007
title: 'ADR007: Use MSW to mock http requests'
# prettier-ignore
description: Architecture Decision Record (ADR) log on Use MSW to mock http requests
---
@@ -1,7 +1,6 @@
---
id: adrs-adr008
title: 'ADR008: Default Catalog File Name'
# prettier-ignore
description: Architecture Decision Record (ADR) log on Default Catalog File Name
---
@@ -1,7 +1,6 @@
---
id: adrs-adr009
title: 'ADR009: Entity References'
# prettier-ignore
description: Architecture Decision Record (ADR) log on Entity References
---
@@ -1,7 +1,6 @@
---
id: adrs-adr010
title: 'ADR010: Use the Luxon Date Library'
# prettier-ignore
description: Architecture Decision Record (ADR) for Luxon Date Library
---
@@ -1,7 +1,6 @@
---
id: adrs-adr011
title: 'ADR011: Plugin Package Structure'
# prettier-ignore
description: Architecture Decision Record (ADR) for Plugin Package Structure
---
@@ -1,7 +1,6 @@
---
id: adrs-adr012
title: 'ADR012: Use Luxon.toLocaleString and date/time presets'
# prettier-ignore
description: Architecture Decision Record (ADR) for using Luxon's toLocaleString method and date/time presets for displaying dates and times
---
@@ -1,7 +1,6 @@
---
id: adrs-adr013
title: 'ADR013: [superseded] Proper use of HTTP fetching libraries'
# prettier-ignore
description: Architecture Decision Record (ADR) for the proper use of fetchApiRef, node-fetch, and cross-fetch for data fetching.
---
@@ -1,7 +1,6 @@
---
id: adrs-adr014
title: 'ADR014: Proper use of HTTP fetching libraries'
# prettier-ignore
description: Architecture Decision Record (ADR) for the proper use of fetchApiRef, native fetch, and cross-fetch for data fetching.
---
-1
View File
@@ -2,7 +2,6 @@
id: adrs-overview
title: Architecture Decision Records (ADR)
sidebar_label: Overview
# prettier-ignore
description: Overview of Architecture Decision Records (ADR)
---
-1
View File
@@ -1,7 +1,6 @@
---
id: autologout
title: Auto Logout
# prettier-ignore
description: This section describes how to setup the Auto Logout mechanism in Backstage
---
-1
View File
@@ -2,7 +2,6 @@
id: gcp-iap-auth
title: Google Identity-Aware Proxy Provider
sidebar_label: Google IAP
# prettier-ignore
description: Adding Google Identity-Aware Proxy as an authentication provider in Backstage
---
-1
View File
@@ -1,7 +1,6 @@
---
id: oauth
title: OAuth and OpenID Connect
# 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
---
-1
View File
@@ -1,7 +1,6 @@
---
id: service-to-service-auth
title: Service to Service Auth
# prettier-ignore
description: This section describes service to service authentication works, both internally within Backstage plugins and when external callers want to make requests.
---
@@ -2,7 +2,6 @@
id: index
title: Backend System Architecture
sidebar_label: Overview
# prettier-ignore
description: The structure and architecture of the new Backend System and its component parts
---
@@ -2,7 +2,6 @@
id: backends
title: Backend Instances
sidebar_label: Backend
# prettier-ignore
description: Backend instances
---
@@ -2,7 +2,6 @@
id: services
title: Backend Services
sidebar_label: Services
# prettier-ignore
description: Services for backend plugins
---
@@ -2,7 +2,6 @@
id: plugins
title: Backend Plugins
sidebar_label: Plugins
# prettier-ignore
description: Backend plugins
---
@@ -2,7 +2,6 @@
id: extension-points
title: Backend Plugin Extension Points
sidebar_label: Extension Points
# prettier-ignore
description: Extension points of backend plugins
---
@@ -2,7 +2,6 @@
id: modules
title: Plugin Modules
sidebar_label: Modules
# prettier-ignore
description: Modules for backend plugins
---
@@ -2,7 +2,6 @@
id: feature-loaders
title: Backend Feature Loaders
sidebar_label: Feature Loaders
# prettier-ignore
description: Backend feature loaders
---
@@ -2,7 +2,6 @@
id: naming-patterns
title: Backend System Naming Patterns
sidebar_label: Naming Patterns
# prettier-ignore
description: Naming patterns in the backend system
---
@@ -2,7 +2,6 @@
id: index
title: Building Backends
sidebar_label: Overview
# prettier-ignore
description: Building backends using the new backend system
---
@@ -2,7 +2,6 @@
id: migrating
title: Migrating your Backend to the New Backend System
sidebar_label: Migration Guide
# prettier-ignore
description: How to migrate existing backends to the new backend system
---
@@ -2,7 +2,6 @@
id: index
title: Building Backend Plugins and Modules
sidebar_label: Overview
# prettier-ignore
description: Building backend plugins and modules using the new backend system
---
@@ -2,7 +2,6 @@
id: testing
title: Testing Backend Plugins and Modules
sidebar_label: Testing
# prettier-ignore
description: Learn how to test your backend plugins and modules
---
@@ -2,7 +2,6 @@
id: migrating
title: Migrating your Backend Plugin to the New Backend System
sidebar_label: Migration Guide
# prettier-ignore
description: How to migrate existing backend plugins to the new backend system
---
@@ -2,7 +2,6 @@
id: index
title: Core Backend Service APIs
sidebar_label: Overview
# prettier-ignore
description: Core backend service APIs
---
-1
View File
@@ -2,7 +2,6 @@
id: index
title: The Backend System
sidebar_label: Introduction
# prettier-ignore
description: Introduction to Backstage's backend system and its documentation
---
-1
View File
@@ -1,7 +1,6 @@
---
id: getting-involved
title: Getting Involved
# prettier-ignore
description: How can you help us build Backstage? We welcome contributions of all kinds, from documentation to code to design.
---
-1
View File
@@ -1,7 +1,6 @@
---
id: index
title: Contributors
# prettier-ignore
description: Documentation on how to get set up for doing development on the Backstage repository
---
-1
View File
@@ -1,7 +1,6 @@
---
id: project-structure
title: Backstage Project Structure
# prettier-ignore
description: Introduction to files and folders in the Backstage Project repository
---
-1
View File
@@ -1,7 +1,6 @@
---
id: figma
title: Figma
# prettier-ignore
description: Documentation on using Figma to build your own plugins for Backstage
---
@@ -2,7 +2,6 @@
id: configuration
title: Configuring Kubernetes integration
sidebar_label: Configuration
# prettier-ignore
description: Configuring the Kubernetes integration for Backstage expose your entity's objects
---
-1
View File
@@ -2,7 +2,6 @@
id: search-overview
title: Search Documentation
sidebar_label: Overview
# prettier-ignore
description: Backstage Search lets you find the right information you are looking for in the Backstage ecosystem.
---
@@ -1,7 +1,6 @@
---
id: catalog-customization
title: Catalog Customization
# prettier-ignore
description: How to add custom filters or interface elements to the Backstage software catalog
---
@@ -2,7 +2,6 @@
id: descriptor-format
title: Descriptor Format of Catalog Entities
sidebar_label: YAML File Format
# prettier-ignore
description: Documentation on Descriptor Format of Catalog Entities which describes the default data shape and semantics of catalog entities
---
@@ -1,7 +1,6 @@
---
id: extending-the-model--old
title: Extending the model
# prettier-ignore
description: Documentation on extending the catalog model
---
@@ -1,7 +1,6 @@
---
id: extending-the-model
title: Extending the model
# prettier-ignore
description: Documentation on extending the catalog model
---
@@ -1,7 +1,6 @@
---
id: external-integrations
title: External integrations
# prettier-ignore
description: Documentation on External integrations to integrate systems with Backstage
---
-1
View File
@@ -2,7 +2,6 @@
id: software-catalog-overview
title: Backstage Software Catalog
sidebar_label: Overview
# prettier-ignore
description: The Backstage Software Catalog
---
@@ -2,7 +2,6 @@
id: life-of-an-entity
title: The Life of an Entity
sidebar_label: The Life of an Entity
# prettier-ignore
description: The life cycle of entities, from being introduced into the catalog, through processing, to being removed again
---
@@ -2,7 +2,6 @@
id: well-known-annotations
title: Well-known Annotations on Catalog Entities
sidebar_label: Well-known Annotations
# prettier-ignore
description: Documentation that lists a number of well known Annotations, that have defined semantics. They can be attached to catalog entities and consumed by plugins as needed.
---
@@ -2,7 +2,6 @@
id: well-known-relations
title: Well-known Relations between Catalog Entities
sidebar_label: Well-known Relations
# prettier-ignore
description: Documentation that lists a number of well known Relations, that have defined semantics. They can be attached to catalog entities and consumed by plugins as needed.
---
@@ -2,7 +2,6 @@
id: well-known-statuses
title: Well-known Status fields of Catalog Entities
sidebar_label: Well-known Statuses
# prettier-ignore
description: Lists a number of well known entity statuses, that have defined semantics. They can be attached to catalog entities and consumed by plugins as needed.
---
@@ -1,7 +1,6 @@
---
id: experimental
title: Experimental Features
# prettier-ignore
description: Information on Experimental Features that are currently available in the Scaffolder
---
@@ -2,7 +2,6 @@
id: software-templates-index
title: Backstage Software Templates
sidebar_label: Overview
# prettier-ignore
description: The Software Templates part of Backstage is a tool that can help you create Components inside Backstage
---
@@ -1,7 +1,6 @@
---
id: migrating-from-v1beta2-to-v1beta3
title: Migrating to v1beta3 templates
# prettier-ignore
description: How to migrate your existing templates to beta3 syntax
---
@@ -1,7 +1,6 @@
---
id: migrating-to-rjsf-v5
title: 'Migrating to react-jsonschema-form@v5'
# prettier-ignore
description: Docs on migrating to `react-jsonschema-form`@v5 and the new designs
---
-1
View File
@@ -2,7 +2,6 @@
id: techdocs-overview
title: TechDocs Documentation
sidebar_label: Overview
# prettier-ignore
description: TechDocs is Spotifys homegrown docs-like-code solution built directly into Backstage
---
-1
View File
@@ -1,7 +1,6 @@
---
id: cli
title: TechDocs CLI
# prettier-ignore
description: TechDocs CLI - a utility command line interface for managing TechDocs sites in Backstage.
---
-1
View File
@@ -1,7 +1,6 @@
---
id: concepts
title: Concepts
# prettier-ignore
description: Documentation on concepts that are introduced with Spotify's docs-like-code solution in Backstage
---
-1
View File
@@ -1,7 +1,6 @@
---
id: configuration
title: TechDocs Configuration Options
# prettier-ignore
description: Reference documentation for configuring TechDocs using app-config.yaml
---
@@ -1,7 +1,6 @@
---
id: configuring-ci-cd
title: Configuring CI/CD to generate and publish TechDocs sites
# prettier-ignore
description: Configuring CI/CD to generate and publish TechDocs sites to cloud storage
---
@@ -2,7 +2,6 @@
id: index
title: Frontend System Architecture
sidebar_label: Overview
# prettier-ignore
description: The structure and architecture of the new Frontend System
---
@@ -2,7 +2,6 @@
id: app
title: App Instances
sidebar_label: App
# prettier-ignore
description: App instances
---
@@ -2,7 +2,6 @@
id: plugins
title: Frontend Plugins
sidebar_label: Plugins
# prettier-ignore
description: Frontend plugins
---
@@ -2,7 +2,6 @@
id: extensions
title: Frontend Extensions
sidebar_label: Extensions
# prettier-ignore
description: Frontend extensions
---
@@ -2,7 +2,6 @@
id: extension-blueprints
title: Frontend Extension Blueprints
sidebar_label: Extensions Blueprints
# prettier-ignore
description: Frontend extensions
---
@@ -2,7 +2,6 @@
id: extension-overrides
title: Frontend Extension Overrides
sidebar_label: Extension Overrides
# prettier-ignore
description: Frontend extension overrides
---
@@ -2,7 +2,6 @@
id: references
title: Value References
sidebar_label: Value References
# prettier-ignore
description: Value References
---
@@ -2,7 +2,6 @@
id: utility-apis
title: Utility APIs
sidebar_label: Utility APIs
# prettier-ignore
description: Utility APIs
---
@@ -2,7 +2,6 @@
id: routes
title: Frontend Routes
sidebar_label: Routes
# prettier-ignore
description: Frontend routes
---
@@ -2,7 +2,6 @@
id: naming-patterns
title: Frontend System Naming Patterns
sidebar_label: Naming Patterns
# prettier-ignore
description: Naming patterns in the frontend system
---
@@ -2,7 +2,6 @@
id: migrations
title: Frontend System Changelog
sidebar_label: Changelog
# prettier-ignore
description: Changelog documentation for different versions of the frontend system core APIs.
---
@@ -2,7 +2,6 @@
id: index
title: Building Frontend Apps
sidebar_label: Overview
# prettier-ignore
description: Building frontend apps using the new frontend system
---
@@ -2,7 +2,6 @@
id: configuring-extensions
title: Configuring Extensions in the App
sidebar_label: Configuring Extensions
# prettier-ignore
description: Documentation for how to configure extensions in a Backstage app
---
@@ -2,7 +2,6 @@
id: built-in-extensions
title: App Built-in Extensions
sidebar_label: Built-in extensions
# prettier-ignore
description: Configuring or overriding built-in extensions
---
@@ -2,7 +2,6 @@
id: plugin-conversion
title: Converting 3rd-party plugins from the old system
sidebar_label: Converting 3rd-party Plugins
# prettier-ignore
description: Documentation for how to convert 3rd-party plugins to support the new frontend system.
---
@@ -2,7 +2,6 @@
id: migrating
title: Migrating Apps
sidebar_label: Migration Guide
# prettier-ignore
description: How to migrate existing apps to the new frontend system
---
@@ -2,7 +2,6 @@
id: index
title: Building Frontend Plugins
sidebar_label: Overview
# prettier-ignore
description: Building frontend plugins using the new frontend system
---
@@ -2,7 +2,6 @@
id: testing
title: Frontend System Testing Plugins
sidebar_label: Testing
# prettier-ignore
description: Testing plugins in the frontend system
---
@@ -2,7 +2,6 @@
id: common-extension-blueprints
title: Common Extension Blueprints
sidebar_label: Common Extension Blueprints
# prettier-ignore
description: Extension blueprints provided by the frontend system and core features
---
@@ -2,7 +2,6 @@
id: built-in-data-refs
title: Built-in data refs
sidebar_label: Built-in data refs
# prettier-ignore
description: Configuring or overriding built-in extension data references
---
@@ -2,7 +2,6 @@
id: migrating
title: Migrating Plugins
sidebar_label: Migration Guide
# prettier-ignore
description: How to migrate an existing frontend plugin to the new frontend system
---
-1
View File
@@ -2,7 +2,6 @@
id: index
title: The Frontend System
sidebar_label: Introduction
# prettier-ignore
description: The Frontend System
---
@@ -2,7 +2,6 @@
id: index
title: Utility APIs
sidebar_label: Overview
# prettier-ignore
description: Working with Utility APIs in the New Frontend System
---
@@ -2,7 +2,6 @@
id: creating
title: Creating Utility APIs
sidebar_label: Creating APIs
# prettier-ignore
description: Creating new utility APIs in your plugins and app
---
@@ -2,7 +2,6 @@
id: consuming
title: Consuming Utility APIs
sidebar_label: Consuming APIs
# prettier-ignore
description: Consuming utility APIs
---
@@ -2,7 +2,6 @@
id: configuring
title: Configuring Utility APIs
sidebar_label: Configuring
# prettier-ignore
description: Configuring, extending, and overriding utility APIs
---
@@ -2,7 +2,6 @@
id: locations
sidebar_label: Locations
title: Amazon Web Services CodeCommit Locations
# prettier-ignore
description: Setting up an integration with Amazon Web Services CodeCommit
---
-1
View File
@@ -2,7 +2,6 @@
id: discovery
title: AWS S3 Discovery
sidebar_label: Discovery
# prettier-ignore
description: Automatically discovering catalog entities from an AWS S3 Bucket
---
-1
View File
@@ -2,7 +2,6 @@
id: locations
sidebar_label: Locations
title: Amazon Web Services S3 Locations
# prettier-ignore
description: Setting up an integration with Amazon Web Services S3
---
@@ -2,7 +2,6 @@
id: discovery
title: Azure Blob Storage Discovery
sidebar_label: Discovery
# prettier-ignore
description: Automatically discovering catalog entities from an Azure Blob Storage account
---
@@ -2,7 +2,6 @@
id: locations
sidebar_label: Locations
title: Azure Blob Storage account Locations
# prettier-ignore
description: Setting up an integration with Azure Blob Storage account
---
-1
View File
@@ -2,7 +2,6 @@
id: discovery
title: Azure DevOps Discovery
sidebar_label: Discovery
# prettier-ignore
description: Automatically discovering catalog entities from repositories in an Azure DevOps organization
---
-1
View File
@@ -2,7 +2,6 @@
id: locations
title: Azure DevOps Locations
sidebar_label: Locations
# prettier-ignore
description: Integrating source code stored in Azure DevOps into the Backstage catalog
---
-1
View File
@@ -2,7 +2,6 @@
id: org
title: Microsoft Entra Tenant Data
sidebar_label: Org Data
# prettier-ignore
description: Importing users and groups from Microsoft Entra ID into Backstage
---
@@ -2,7 +2,6 @@
id: discovery
title: Bitbucket Cloud Discovery
sidebar_label: Discovery
# prettier-ignore
description: Automatically discovering catalog entities from repositories in Bitbucket Cloud
---
@@ -2,7 +2,6 @@
id: locations
title: Bitbucket Cloud Locations
sidebar_label: Locations
# prettier-ignore
description: Integrating source code stored in Bitbucket Cloud into the Backstage catalog
---
@@ -2,7 +2,6 @@
id: discovery
title: Bitbucket Server Discovery
sidebar_label: Discovery
# prettier-ignore
description: Automatically discovering catalog entities from repositories in Bitbucket Server
---
@@ -2,7 +2,6 @@
id: locations
title: Bitbucket Server Locations
sidebar_label: Locations
# prettier-ignore
description: Integrating source code stored in Bitbucket Server into the Backstage catalog
---
@@ -2,7 +2,6 @@
id: installation
title: Datadog RUM Installation
sidebar_label: Installation
# prettier-ignore
description: Adding Datadog Real User Monitoring (RUM) to Your App
---
-1
View File
@@ -2,7 +2,6 @@
id: discovery
title: Gerrit Discovery
sidebar_label: Discovery
# prettier-ignore
description: Automatically discovering catalog entities from Gerrit repositories
---

Some files were not shown because too many files have changed in this diff Show More