diff --git a/assessments/0008-backstage/backstage-doc-survey.csv b/assessments/0008-backstage/backstage-doc-survey.csv index 775fe92..c23af5c 100644 --- a/assessments/0008-backstage/backstage-doc-survey.csv +++ b/assessments/0008-backstage/backstage-doc-survey.csv @@ -1,185 +1,185 @@ -Title,URL,Doc Type,User Role,Use Case,Doc Suite Position,Comment -Overview,,,,,, -What is Backstage?,https://backstage.io/docs/overview/what-is-backstage,concept,adopter,decision,Technical Overview,Introductory -Architecture overview,https://backstage.io/docs/overview/architecture-overview,concept,administrator,deployment,Architecture Overview,"Substantial, in-depth view of architecture" -Roadmap,https://backstage.io/docs/overview/roadmap,concept,administrator,"deployment, maintenance",Release Notes,Should be updated frequently; move to release notes -Vision,https://backstage.io/docs/overview/vision,concept,"contributor, adopter","strategy, sales",White Paper,"Short, high-level statement of vision." -The Spotify Story,https://backstage.io/docs/overview/background,concept,"contributor, adopter","strategy, sales",White Paper,Background info. Move to website. -Strategies for adopting,https://backstage.io/docs/overview/adopting,concept,adopter,decision,Overview,"Would be useful in adoption go/no-go decisions, and in adoption/deployment/configuration." -Release and Versioning Policy,https://backstage.io/docs/overview/versioning-policy,concept,"contributor, adopter","contribute, maintenance","Release Notes, Contributor Instructions", -Backstage Threat Model,https://backstage.io/docs/overview/threat-model,concept,administrator,deployment,"Architecture Overview, Installation Guide",Required by admin to set up security posture -Support and community,https://backstage.io/docs/overview/support,reference,any,"support, decision, contrib","RN, FAQ, KB, Overviews",Should be available to any interested user from almost anywhere -Backstage Glossary,https://backstage.io/docs/overview/glossary,reference,any,any,KB,"Should be available generally, esp. to new users" -Logo assets,https://backstage.io/docs/overview/logos,reference,"contributor, adopter",contribute,,Reference info for contributing designer -Getting Started,,,,,, -Getting Started,https://backstage.io/docs/getting-started/,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Installation instructions -Getting Started configuring Backstage,https://backstage.io/docs/getting-started/configuration,task,administrator; user,"installation, setup, config","Installation, Setup, and Config Guide; Getting Started Guide","Split: Configuring database, authentication (installation); Creating your first components (getting started)" -Create an App,https://backstage.io/docs/getting-started/create-an-app,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide","How to set up an instance. Might need two setup procedures, one for users and one for admins." -Configuring App with plugins,https://backstage.io/docs/getting-started/configure-app-with-plugins,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Should go in a chapter of the install guide devoted to installing existing plugins -Customize the look-and-feel of your App,https://backstage.io/docs/getting-started/app-custom-theme,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Should be a chapter of the install guide -Backstage homepage - Setup and Customization,https://backstage.io/docs/getting-started/homepage,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide", -Keeping Backstage Updated,https://backstage.io/docs/getting-started/keeping-backstage-updated,task,administrator,"installation, setup, config",IS&C; RN,Upgrade procedures in admin guide; particular upgrades in release notes -Key Concepts,https://backstage.io/docs/getting-started/concepts,reference,administrator,,,This is a list of software dependencies. Needed by admin. Upgrades needed by each release in RN. -Contributors,https://backstage.io/docs/getting-started/contributors,task,contributor,contribute,Contributor setup guide,"Contributor guide can be limited to GitHub, or a separate contributor guide put on the website" -Getting Involved,https://backstage.io/docs/getting-started/getting-involved,reference,contributor,contribute,Contributor overview,This material belongs in the intro to a contributor guide -Backstage Project Structure,https://backstage.io/docs/getting-started/project-structure,reference,contributor,contribute,Contributor reference,"Structure of the GitHub repo, annotated. Reference for contributors." -Local Development,,,,,, -Overview,https://backstage.io/docs/local-dev/cli-overview,concept,administrator,deployment,Architecture Overview,"This is part of the architecture overview, a discussion of the components of the CLI" -Build System,https://backstage.io/docs/local-dev/cli-build-system,concept,administrator,deployment,Architecture Overview,Description of how the Build system works; belongs in the Architecture Overview -Commands,https://backstage.io/docs/local-dev/cli-commands,reference,administrator; user,use,API Reference,"This is a command reference for the CLI, which seems to be a tool for doing builds of components in Backstage" -Linking in Local Packages,https://backstage.io/docs/local-dev/linking-local-packages,task,user,use,Recipe,This is a technique for testing a build. Goes in a recipe book or use and testing guide. -Debugging Backstage,https://backstage.io/docs/local-dev/debugging,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Description of how to change the logging level in Backstage. -Core Features,,,,,, -Overview,https://backstage.io/docs/features/software-catalog/,task,user,use,User Guide,Basic catalog tasks. Also a short intro to the catalog (conceptual). -The Life of an Entity,https://backstage.io/docs/features/software-catalog/life-of-an-entity,concept,administrator; user,deployment,Architecture Overview,Detailed description of data ingestion when importing an entity. -Catalog Configuration,https://backstage.io/docs/features/software-catalog/configuration,concept,administrator; user,deployment,Architecture Overview,Additional information for ingesting entities -System Model,https://backstage.io/docs/features/software-catalog/system-model,concept,user,use,User Guide,Describes the model behind various entities. Some of this could go in the Knowledge Base as well maybe. -YAML File Format,https://backstage.io/docs/features/software-catalog/descriptor-format,reference,user,use,User Guide,"Reference to entity descriptors, with examples in JSON." -Entity References,https://backstage.io/docs/features/software-catalog/references,reference,user,use,User Guide,Description of how entities reference other entities -Well-known Annotations,https://backstage.io/docs/features/software-catalog/well-known-annotations,reference,user,use,User Guide,More on entities -Well-known Relations,https://backstage.io/docs/features/software-catalog/well-known-relations,reference,user,use,User Guide,More on entities -Well-known Statuses,https://backstage.io/docs/features/software-catalog/well-known-statuses,reference,user,use,User Guide,More on entities -Extending the model,https://backstage.io/docs/features/software-catalog/extending-the-model,reference,user,use,User Guide,More on entities -External integrations,https://backstage.io/docs/features/software-catalog/external-integrations,reference,user,use,User Guide,More on entities -Catalog Customization,https://backstage.io/docs/features/software-catalog/catalog-customization,task,administrator,deployment,"Installation, Setup, and Config Guide",How to customize the entity display page. A recipe for the site admin -API,https://backstage.io/docs/features/software-catalog/software-catalog-api,reference,administrator; user,use,API Reference,The Entity API. Could be teased apart into a true reference and a set of recipes. -Creating the Catalog Graph,https://backstage.io/docs/features/software-catalog/creating-the-catalog-graph,reference,user,use,User Guide,Describes the catalog model and what is displayed in the UI -Overview,https://backstage.io/docs/features/kubernetes/,concept,user,use,Kubernetes plugin guide,Intro to the 2 Kubernetes plugins -Installation,https://backstage.io/docs/features/kubernetes/installation,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Could go in the main install guide or in a separate k8s guide -Configuration,https://backstage.io/docs/features/kubernetes/configuration,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide","Continuation of k8s install instructions, but contains mostly descriptions of the config settings" -Kubernetes Authentication,https://backstage.io/docs/features/kubernetes/authentication,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Describes how to authenticate k8s on various services. -Troubleshooting,https://backstage.io/docs/features/kubernetes/troubleshooting,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",What to do if k8s doesn’t show up as a service entity -Proxy,https://backstage.io/docs/features/kubernetes/proxy,task,"contributor, admin","installation, setup, config","Installation, Setup, and Config Guide",How to set up a k8s proxy endpoint. Known limitation should be moved to a release note. -Overview,https://backstage.io/docs/features/software-templates/,task,administrator; user,getting started,Getting Started Guide (“Hello World”),“Disable Register Existing Component button” is an admin task that should be in the config documentation -Configuration,https://backstage.io/docs/features/software-templates/configuration,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to configure a template -Adding your own Templates,https://backstage.io/docs/features/software-templates/adding-templates,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to add a template -Writing Templates,https://backstage.io/docs/features/software-templates/writing-templates,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",The anatomy of a template and how to write one. -Input Examples,https://backstage.io/docs/features/software-templates/input-examples,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Anatomy of template input components. Could be a mini-cookbook or a section of the config instructions for Templates -Builtin actions,https://backstage.io/docs/features/software-templates/builtin-actions,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Describes how to migrate a fetch action from a one fetch action to another. Not clear why this is important; should give some more context. -Writing Custom Actions,https://backstage.io/docs/features/software-templates/writing-custom-actions,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to create a custom template action -Writing Custom Field Extensions,https://backstage.io/docs/features/software-templates/writing-custom-field-extensions,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",More on customizing templates: creating your own field types -Writing custom step layouts,https://backstage.io/docs/features/software-templates/writing-custom-step-layouts,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Still more on customizing templates: creating your own step layouts -Authorizing parameters steps and actions,https://backstage.io/docs/features/software-templates/authorizing-parameters-steps-and-actions,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Authorization in custom templates -Experimental: Testing out the alpha Scaffolder plugin,https://backstage.io/docs/features/software-templates/testing-scaffolder-alpha,task,administrator,"installation, setup, config",Release Notes,Information about features that are in flux or still in development should have their own documentation separate from the production system. The feature should be described in the Release Notes. -Migrating to v1beta3 templates,https://backstage.io/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3,,administrator,"installation, setup, config",Release Notes,Information about features that are in flux or still in development should have their own documentation separate from the production system. The feature should be described in the Release Notes. -Overview,https://backstage.io/docs/features/search/,concept,administrator; user,use,User Guide,"Intro to the search feature, including its configurability as a plugin" -Getting Started with Search,https://backstage.io/docs/features/search/getting-started,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Installing and configuring frontend and backend search -Search Concepts,https://backstage.io/docs/features/search/concepts,concept,administrator; user,"deployment, use",Technical Overview,Description of search system components. -Search Architecture,https://backstage.io/docs/features/search/architecture,concept,all,"decision, deployment",Architecture Overview,Description of search architecture -Search Engines,https://backstage.io/docs/features/search/search-engines,concept,administrator; user,deployment,Architecture Overview,Describes search backends available by default -How-To guides,https://backstage.io/docs/features/search/how-to-guides,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to deploy a custom search backend -Overview,https://backstage.io/docs/features/techdocs/,concept,all,"decision, deployment",Architecture Overview,Intro to tech docs feature -Getting Started,https://backstage.io/docs/features/techdocs/getting-started,task,administrator; user,"installation, setup, config","Installation, Setup, and Config Guide",Install and config instructions for the TechDoc frontend and backend plugins -Concepts,https://backstage.io/docs/features/techdocs/concepts,concept,administrator; user,"deployment, use","Architecture Overview, Installation Guide",Describes the TechDocs plugin component architecture. -TechDocs Addons,https://backstage.io/docs/features/techdocs/addons,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Describes how to install and configure add-ons to the TechDocs plugin -TechDocs Architecture,https://backstage.io/docs/features/techdocs/architecture,concept,administrator; user,deployment,Architecture Overview,TechDocs architecture block diagrams. -Creating and Publishing Documentation,https://backstage.io/docs/features/techdocs/creating-and-publishing,task,user,use,User Guide,How to add existing docs or create a new doc in TechDcos -TechDocs Configuration Options,https://backstage.io/docs/features/techdocs/configuration,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide",A description in an example YAML file of the TechDocs configuration parameters. Don’t know if it’s comprehensive or not. -Using Cloud Storage for TechDocs generated files,https://backstage.io/docs/features/techdocs/using-cloud-storage,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to set up TechDocs on major cloud services -Configuring CI/CD to generate and publish TechDocs sites,https://backstage.io/docs/features/techdocs/configuring-ci-cd,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to automate TechDocs publication in CI/CD -TechDocs CLI,https://backstage.io/docs/features/techdocs/cli,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Reference and how-to information on using the CLI. A bit of a catch-all; should be parceled out in more focused docs. -How-To guides,https://backstage.io/docs/features/techdocs/how-to-guides,task,administrator; user,"deployment, use",Recipe,How-tos for various TechDocs tasks. probably partly redundant with other pages. -Troubleshooting,https://backstage.io/docs/features/techdocs/troubleshooting,task,administrator; user,"deployment, use",Maintenance Guide; User Guide,How to solve several trouble scenarios -FAQ,https://backstage.io/docs/features/techdocs/faqs,concept,administrator; user,"deployment, use",KB,Info about the TechDocs plugin. Probably partly redundant with other pages. -Integrations,,,,,, -Overview,https://backstage.io/docs/integrations/,concept,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Intro to integrations. Needs to be expanded. There are about a dozen listed integrations with common cloud providers and software repos. This could be its own supplement to the installation guide or a chapter or appendix. It's almost certain to be needed for any major installation. -Plugins,,,,,, -Intro to plugins,https://backstage.io/docs/plugins/,concept,administrator,deployment,Architecture Overview,"This introduction needs to be expanded (though that material might exist elsewhere). There are pointers here mostly to contributor actions. ""Contributing a plugin"" needs to be its own separate document on the GitHub site." -Existing plugins,https://backstage.io/docs/plugins/existing-plugins,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide",This is a pointer to the plugin catalog. The catalog should be an appendix to the installation and config guide. -Create a Backstage Plugin,https://backstage.io/docs/plugins/create-a-plugin,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",This is actually a brief description of how to install a plugin on an existing Backstage instance. -Plugin Development,https://backstage.io/docs/plugins/plugin-development,concept,"contributor, admin","contribute, maintenance",Contributor reference,A brief outline of how to develop a plugin. Should go in the contributor guide. -Structure of a Plugin,https://backstage.io/docs/plugins/structure-of-a-plugin,reference,"contributor, admin","contribute, maintenance",Contributor reference,Description of the structure of a plugin. -Integrate into the Software Catalog,https://backstage.io/docs/plugins/integrating-plugin-into-software-catalog,task,contributor,contribute,Contributor reference,"Describes how to add a plugin to the entities page on a Backstage instance. Described as ""advanced"" and ""experimental""." -Integrating Search into a plugin,https://backstage.io/docs/plugins/integrating-search-into-plugins,task,contributor,contribute,Contributor reference,Instructions for implementing search in a plugin. -Composability System,https://backstage.io/docs/plugins/composability,concept,contributor,contribute,Contributor reference,How plugins talk to each other using React extension. Contains some instructional code that should be separated into a procedure. -Customization (Experimental),https://backstage.io/docs/plugins/customization,task,"contributor, user","contribute, use","Contributor reference, User guide","How to customize a plugin. Instructions for both contributor (plugin developer) and a short snippet for a developer to use in an existing installation. Labeled ""experimental""." -Plugin Analytics,https://backstage.io/docs/plugins/analytics,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide","Conceptual, reference, and (mostly) task information about using a supplied analytics API to collect usage data on Backstage." -Feature Flags,https://backstage.io/docs/plugins/feature-flags,task,administrator; user,"installation, setup, config","Installation, Setup, and Config Guide","How to set features flags to define plugin behavior, both in plugin code and from the Backstage application." -Proxying,https://backstage.io/docs/plugins/proxying,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to set up an HTTP proxy to reach backend services from the Backstage frontend -Backend plugins,https://backstage.io/docs/plugins/backend-plugin,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Instructions for an admin to create and configure a backend plugin. This is one of those pieces of content that spans admin and contributor. -Call Existing API,https://backstage.io/docs/plugins/call-existing-api,task,administrator; user,"installation, setup, config","Installation, Setup, and Config Guide",How to call an arbitrary API from the Backstage frontend -URL Reader,https://backstage.io/docs/plugins/url-reader,task,contributor,contribute,Contributor reference,How to use the Backstage URL reader API to securely read files from a plugin. -Testing with Jest,https://backstage.io/docs/plugins/testing,concept,contributor,contribute,Contributor reference,A description of the infrastructure (Jest) and principles to use when writing unit tests for plugins. -Publish private,https://backstage.io/docs/plugins/publish-private,,,,,"""TODO""" -Add to Marketplace,https://backstage.io/docs/plugins/add-to-marketplace,task,contributor,contribute,Contributor reference,How to add a plugin to the plugin library listed in the documentation -Observability,https://backstage.io/docs/plugins/observability,reference,contributor,contribute,Contributor reference,A brief overview of some logging mechanisms. Covered elsewhere. -Configuration,,,,,, -Static Configuration in Backstage,https://backstage.io/docs/conf/,reference,contributor,"contribute, maintenance",Contributor reference,These sections describe the static configuration files for plugins and how they're combined into the configuration for a Backstage implementation. -Reading Backstage Configuration,https://backstage.io/docs/conf/reading,reference,contributor,"contribute, maintenance",Contributor reference,These sections describe the static configuration files for plugins and how they're combined into the configuration for a Backstage implementation. -Writing Backstage Configuration Files,https://backstage.io/docs/conf/writing,reference,contributor,"contribute, maintenance",Contributor reference,These sections describe the static configuration files for plugins and how they're combined into the configuration for a Backstage implementation. -Defining Configuration for your Plugin,https://backstage.io/docs/conf/defining,reference,contributor,"contribute, maintenance",Contributor reference,These sections describe the static configuration files for plugins and how they're combined into the configuration for a Backstage implementation. -Auth and identity,,,,,, -Authentication in Backstage,https://backstage.io/docs/auth/,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide","How to configure authentication. There are at least 14 individual pages for various providers giving detailed instructions for these providers: ""https://backstage.io/docs/auth/atlassian/provider"" and so on." -Sign-in Identities and Resolvers,https://backstage.io/docs/auth/identity-resolver,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to set up identities for authorization. Probably useful to plugin contributors as well. -OAuth and OpenID Connect,https://backstage.io/docs/auth/oauth,concept,"contributor, admin","contribute, maintenance","Contributor reference, User guide",Describes how tokens are used by Backstage for third-party services. Includes a sequence diagram. -OIDC provider from scratch,https://backstage.io/docs/auth/oidc,task,"contributor, admin",contribute,Contributor reference,How to use Open ID Connect (OIDC) to connect to Backstage. -Contributing New Providers,https://backstage.io/docs/auth/add-auth-provider,task,contributor,contribute,Contributor reference,How to add support for a new authentication provider. Recommended solely for contributors. -Service to Service Auth,https://backstage.io/docs/auth/service-to-service-auth,task,contributor,contribute,Contributor reference,How to set up a plugin to authenticate another service or plugin. -Troubleshooting Auth,https://backstage.io/docs/auth/troubleshooting,task,"contributor, admin",contribute,"Installation, Setup, and Config Guide",Troubleshooting various authentication problems. These span development of plugins to administration of Backstage instances. -Glossary,https://backstage.io/docs/auth/glossary,reference,all,any,,A glossary of terms for authentication. -Permissions,,,,,, -Overview,https://backstage.io/docs/permissions/overview,concept,all,deployment,Architecture Overview,"An introduction to authorization in Backstage, with a flow diagram." -Concepts,https://backstage.io/docs/permissions/concepts,reference,"contributor, admin","contribute, maintenance",Contributor reference,A glossary of authorization terms. -Getting Started,https://backstage.io/docs/permissions/getting-started,task,"contributor, admin","contribute, maintenance",Contributor reference,How to set up authorization in a Backstage plugin. -Writing a permission policy,https://backstage.io/docs/permissions/writing-a-policy,task,"contributor, admin","contribute, maintenance",Contributor reference,How to write a permission policy in a Typescript file. -Frontend Integration,https://backstage.io/docs/permissions/frontend-integration,task,"contributor, admin","contribute, maintenance",Contributor reference,An example showing what to do when frontend permission policy needs to be set. -Defining custom permission rules,https://backstage.io/docs/permissions/custom-rules,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to set up a custom rule outside the context of a plugin. -1. Tutorial setup,https://backstage.io/docs/permissions/plugin-authors/01-setup,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. -2. Adding a basic permission check,https://backstage.io/docs/permissions/plugin-authors/02-adding-a-basic-permission-check,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. -3. Adding a resource permission check,https://backstage.io/docs/permissions/plugin-authors/03-adding-a-resource-permission-check,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. -4. Authorizing access to paginated data,https://backstage.io/docs/permissions/plugin-authors/04-authorizing-access-to-paginated-data,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. -5. Frontend Components with Authorization,https://backstage.io/docs/permissions/plugin-authors/05-frontend-authorization,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. -Deployment,,,,,, -Overview,https://backstage.io/docs/deployment/,concept,administrator,deployment,"Installation, Setup, and Config Guide",Introduction to deploying a Backstage instance. -Scaling,https://backstage.io/docs/deployment/scaling,concept,administrator,deployment,"Installation, Setup, and Config Guide",Brief discussion of how to scale Backstage across an org -Docker,https://backstage.io/docs/deployment/docker,task,administrator,deployment,"Installation, Setup, and Config Guide",How to deploy using Docker. -Kubernetes,https://backstage.io/docs/deployment/k8s,task,administrator,deployment,"Installation, Setup, and Config Guide",Fairly extensive instructions on how to deploy Backstage using Docker on Kubernetes -Heroku,https://backstage.io/docs/deployment/heroku,task,administrator,deployment,"Installation, Setup, and Config Guide",Deploying using Heroic -Koyeb,https://backstage.io/docs/deployment/koyeb,task,administrator,deployment,"Installation, Setup, and Config Guide",Deploying using Kobe -AWS Fargate via Flightcontrol,https://backstage.io/docs/deployment/flightcontrol,task,administrator,deployment,"Installation, Setup, and Config Guide",Deploying on AWS using Flightcontrol -Designing for Backstage,,,,,, -Design,https://backstage.io/docs/dls/design,concept,contributor,contribute,Contributor overview,Introduction to the Backstage OSS project. -Component Design Guidelines,https://backstage.io/docs/dls/component-design-guidelines,concept,contributor,contribute,Contributor reference,Visual design guidelines for components -Contributing to Storybook,https://backstage.io/docs/dls/contributing-to-storybook,task,contributor,contribute,Contributor reference,How to add a control to the Backstage Storybook catalog -Figma,https://backstage.io/docs/dls/figma,reference,contributor,contribute,Contributor reference,Link to the Figma component library for Backstage -API Reference,,,,,, -Utility APIs,https://backstage.io/docs/api/utility-apis,task,contributor,contribute,Contributor reference,Describes the infrastructure for creating and using APIs that operate between plugins. -Package Index,https://backstage.io/docs/reference/,reference,contributor,contribute,Contributor reference,A lengthy catalog of APIs -Deprecations,https://backstage.io/docs/api/deprecations,reference,all,any,,Describes deprecated elements in Backstage. Deprecations should be noted in reference material and described in release notes. -Tutorials,,,,,, -Future developer journey,https://backstage.io/docs/tutorials/journey,task,"contributor, admin",contribute,Recipe,"Extended example about a fictional developer adding a new plugin to an installation, then to the project" -Adding Custom Plugin to Existing Monorepo App,https://backstage.io/docs/tutorials/quickstart-app-plugin,task,administrator,deployment,Recipe,How to develop a plugin in an existing Backstage installation (app) -React Router 6.0 Migration,https://backstage.io/docs/tutorials/react-router-stable-migration,task,administrator,"installation, setup, config",Release Notes,"How to upgrade to a newer version of React router. A version-specific procedure that should be hidden from general admin procedures. Should have been a release-specific task, if necessary at all" -Package Role Migration,https://backstage.io/docs/tutorials/package-role-migration,task,administrator,"installation, setup, config",Release Notes,"Another transitional step that should be part of a version upgrade, not a user tutorial." -Migrating away from @backstage/core,https://backstage.io/docs/tutorials/migrating-away-from-core,task,administrator,"installation, setup, config",Release Notes,Another refactoring migration. Remove from tutorials. -Configuring Plugin Databases,https://backstage.io/docs/tutorials/configuring-plugin-databases,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide","I could see putting this in a recipe guide or a config guide, plugin-specific or otherwise. Not a tutorial." -Switching Backstage from SQLite to PostgreSQL,https://backstage.io/docs/tutorials/switching-sqlite-postgres,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to change the default DB from SQLite to PostgreSQL. This should be in the basic configuration guide. -Using the Backstage Proxy from Within a Plugin,https://backstage.io/docs/tutorials/using-backstage-proxy-within-plugin,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to access an external API using a proxy. A plugin configuration task. -Migration to Yarn 3,https://backstage.io/docs/tutorials/yarn-migration,task,administrator,deployment,Release Notes,Another release-specific migration. Remove from tutorials. -Architecture Decision Records (ADRs),,,,,, -Overview,https://backstage.io/docs/architecture-decisions/,concept,"contributor, admin",deployment,Architecture Overview,"An intro to architectural decision records (ADRs). Potentially part of an architecture overview. Could be omitted from the user doc altogether, though. Primarily of interest to contributors." -ADR001: Architecture Decision Record (ADR) log,https://backstage.io/docs/architecture-decisions/adrs-adr001,concept,contributor,contribute,Contributor reference,Meta ADR about where to store ADRs. -ADR002: Default Software Catalog File Format,https://backstage.io/docs/architecture-decisions/adrs-adr002,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR003: Avoid Default Exports and Prefer Named Exports,https://backstage.io/docs/architecture-decisions/adrs-adr003,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR004: Module Export Structure,https://backstage.io/docs/architecture-decisions/adrs-adr004,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR005: Catalog Core Entities,https://backstage.io/docs/architecture-decisions/adrs-adr005,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR006: Avoid React.FC and React.SFC,https://backstage.io/docs/architecture-decisions/adrs-adr006,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR007: Use MSW to mock http requests,https://backstage.io/docs/architecture-decisions/adrs-adr007,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR008: Default Catalog File Name,https://backstage.io/docs/architecture-decisions/adrs-adr008,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR009: Entity References,https://backstage.io/docs/architecture-decisions/adrs-adr009,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR010: Use the Luxon Date Library,https://backstage.io/docs/architecture-decisions/adrs-adr010,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR011: Plugin Package Structure,https://backstage.io/docs/architecture-decisions/adrs-adr011,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR012: Use Luxon.toLocaleString and date/time presets,https://backstage.io/docs/architecture-decisions/adrs-adr012,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -ADR013: Proper use of HTTP fetching libraries,https://backstage.io/docs/architecture-decisions/adrs-adr013,concept,contributor,contribute,Contributor reference,Information about a particular design decision. -FAQ,,,,,, -FAQ,https://backstage.io/docs/FAQ,reference,all,any,KB,"This is a fairly robust FAQ. I usually recommend doing away with a FAQ on the grounds that it's a last resort for someone looking for information. Distribute its topics to where they belong in the documentation. Use a knowledge base (similar, but longer-format articles with conceptual information only) for miscellaneous, indexed, conceptual information." -Experimental Backend System,,,,,, -Introduction,https://backstage.io/docs/backend-system/,concept,"contributor, admin",deployment,Contributor reference,"Information about a refactoring of existing functionality should be kept in the developer (contributor) discussion until it is deployed, at which point it should be documented in the release notes. Mentions of timing (""this component is in alpha""; ""currently this works like this""; ""we plan to ..."") should be avoided entirely in the product regular documentation. Version-specific information should be documented at the time of release in the release notes. If the change affects functionality, the new functionality should replace the old in the documentation set starting at the new version of the doc." -Overview,https://backstage.io/docs/backend-system/architecture/index,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" -Services,https://backstage.io/docs/backend-system/architecture/services,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" -Plugins,https://backstage.io/docs/backend-system/architecture/plugins,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" -Extension Points,https://backstage.io/docs/backend-system/architecture/extension-points,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" -Modules,https://backstage.io/docs/backend-system/architecture/modules,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" -Naming Patterns,https://backstage.io/docs/backend-system/architecture/naming-patterns,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" -Accessibility,,,,,, -Backstage Accessibility,https://backstage.io/docs/accessibility/,task,contributor,contribute,Contributor reference,How to incorporate accessibility into contributed software components +Title,URL,Doc Type,User Role,Use Case,Doc Suite Position,Comment +Overview,,,,,, +What is Backstage?,https://backstage.io/docs/overview/what-is-backstage,concept,adopter,decision,Technical Overview,Introductory +Architecture overview,https://backstage.io/docs/overview/architecture-overview,concept,administrator,deployment,Architecture Overview,"Substantial, in-depth view of architecture" +Roadmap,https://backstage.io/docs/overview/roadmap,concept,administrator,"deployment, maintenance",Release Notes,Should be updated frequently; move to release notes +Vision,https://backstage.io/docs/overview/vision,concept,"contributor, adopter","strategy, sales",White Paper,"Short, high-level statement of vision." +The Spotify Story,https://backstage.io/docs/overview/background,concept,"contributor, adopter","strategy, sales",White Paper,Background info. Move to website. +Strategies for adopting,https://backstage.io/docs/overview/adopting,concept,adopter,decision,Overview,"Would be useful in adoption go/no-go decisions, and in adoption/deployment/configuration." +Release and Versioning Policy,https://backstage.io/docs/overview/versioning-policy,concept,"contributor, adopter","contribute, maintenance","Release Notes, Contributor Instructions", +Backstage Threat Model,https://backstage.io/docs/overview/threat-model,concept,administrator,deployment,"Architecture Overview, Installation Guide",Required by admin to set up security posture +Support and community,https://backstage.io/docs/overview/support,reference,any,"support, decision, contrib","RN, FAQ, KB, Overviews",Should be available to any interested user from almost anywhere +Backstage Glossary,https://backstage.io/docs/overview/glossary,reference,any,any,KB,"Should be available generally, esp. to new users" +Logo assets,https://backstage.io/docs/overview/logos,reference,"contributor, adopter",contribute,,Reference info for contributing designer +Getting Started,,,,,, +Getting Started,https://backstage.io/docs/getting-started/,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Installation instructions +Getting Started configuring Backstage,https://backstage.io/docs/getting-started/configuration,task,administrator; user,"installation, setup, config","Installation, Setup, and Config Guide; Getting Started Guide","Split: Configuring database, authentication (installation); Creating your first components (getting started)" +Create an App,https://backstage.io/docs/getting-started/create-an-app,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide","How to set up an instance. Might need two setup procedures, one for users and one for admins." +Configuring App with plugins,https://backstage.io/docs/getting-started/configure-app-with-plugins,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Should go in a chapter of the install guide devoted to installing existing plugins +Customize the look-and-feel of your App,https://backstage.io/docs/getting-started/app-custom-theme,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Should be a chapter of the install guide +Backstage homepage - Setup and Customization,https://backstage.io/docs/getting-started/homepage,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide", +Keeping Backstage Updated,https://backstage.io/docs/getting-started/keeping-backstage-updated,task,administrator,"installation, setup, config",IS&C; RN,Upgrade procedures in admin guide; particular upgrades in release notes +Key Concepts,https://backstage.io/docs/getting-started/concepts,reference,administrator,,,This is a list of software dependencies. Needed by admin. Upgrades needed by each release in RN. +Contributors,https://backstage.io/docs/getting-started/contributors,task,contributor,contribute,Contributor setup guide,"Contributor guide can be limited to GitHub, or a separate contributor guide put on the website" +Getting Involved,https://backstage.io/docs/getting-started/getting-involved,reference,contributor,contribute,Contributor overview,This material belongs in the intro to a contributor guide +Backstage Project Structure,https://backstage.io/docs/getting-started/project-structure,reference,contributor,contribute,Contributor reference,"Structure of the GitHub repo, annotated. Reference for contributors." +Local Development,,,,,, +Overview,https://backstage.io/docs/local-dev/cli-overview,concept,administrator,deployment,Architecture Overview,"This is part of the architecture overview, a discussion of the components of the CLI" +Build System,https://backstage.io/docs/local-dev/cli-build-system,concept,administrator,deployment,Architecture Overview,Description of how the Build system works; belongs in the Architecture Overview +Commands,https://backstage.io/docs/local-dev/cli-commands,reference,administrator; user,use,API Reference,"This is a command reference for the CLI, which seems to be a tool for doing builds of components in Backstage" +Linking in Local Packages,https://backstage.io/docs/local-dev/linking-local-packages,task,user,use,Recipe,This is a technique for testing a build. Goes in a recipe book or use and testing guide. +Debugging Backstage,https://backstage.io/docs/local-dev/debugging,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Description of how to change the logging level in Backstage. +Core Features,,,,,, +Overview,https://backstage.io/docs/features/software-catalog/,task,user,use,User Guide,Basic catalog tasks. Also a short intro to the catalog (conceptual). +The Life of an Entity,https://backstage.io/docs/features/software-catalog/life-of-an-entity,concept,administrator; user,deployment,Architecture Overview,Detailed description of data ingestion when importing an entity. +Catalog Configuration,https://backstage.io/docs/features/software-catalog/configuration,concept,administrator; user,deployment,Architecture Overview,Additional information for ingesting entities +System Model,https://backstage.io/docs/features/software-catalog/system-model,concept,user,use,User Guide,Describes the model behind various entities. Some of this could go in the Knowledge Base as well maybe. +YAML File Format,https://backstage.io/docs/features/software-catalog/descriptor-format,reference,user,use,User Guide,"Reference to entity descriptors, with examples in JSON." +Entity References,https://backstage.io/docs/features/software-catalog/references,reference,user,use,User Guide,Description of how entities reference other entities +Well-known Annotations,https://backstage.io/docs/features/software-catalog/well-known-annotations,reference,user,use,User Guide,More on entities +Well-known Relations,https://backstage.io/docs/features/software-catalog/well-known-relations,reference,user,use,User Guide,More on entities +Well-known Statuses,https://backstage.io/docs/features/software-catalog/well-known-statuses,reference,user,use,User Guide,More on entities +Extending the model,https://backstage.io/docs/features/software-catalog/extending-the-model,reference,user,use,User Guide,More on entities +External integrations,https://backstage.io/docs/features/software-catalog/external-integrations,reference,user,use,User Guide,More on entities +Catalog Customization,https://backstage.io/docs/features/software-catalog/catalog-customization,task,administrator,deployment,"Installation, Setup, and Config Guide",How to customize the entity display page. A recipe for the site admin +API,https://backstage.io/docs/features/software-catalog/software-catalog-api,reference,administrator; user,use,API Reference,The Entity API. Could be teased apart into a true reference and a set of recipes. +Creating the Catalog Graph,https://backstage.io/docs/features/software-catalog/creating-the-catalog-graph,reference,user,use,User Guide,Describes the catalog model and what is displayed in the UI +Overview,https://backstage.io/docs/features/kubernetes/,concept,user,use,Kubernetes plugin guide,Intro to the 2 Kubernetes plugins +Installation,https://backstage.io/docs/features/kubernetes/installation,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Could go in the main install guide or in a separate k8s guide +Configuration,https://backstage.io/docs/features/kubernetes/configuration,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide","Continuation of k8s install instructions, but contains mostly descriptions of the config settings" +Kubernetes Authentication,https://backstage.io/docs/features/kubernetes/authentication,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Describes how to authenticate k8s on various services. +Troubleshooting,https://backstage.io/docs/features/kubernetes/troubleshooting,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",What to do if k8s doesn’t show up as a service entity +Proxy,https://backstage.io/docs/features/kubernetes/proxy,task,"contributor, admin","installation, setup, config","Installation, Setup, and Config Guide",How to set up a k8s proxy endpoint. Known limitation should be moved to a release note. +Overview,https://backstage.io/docs/features/software-templates/,task,administrator; user,getting started,Getting Started Guide (“Hello World”),“Disable Register Existing Component button” is an admin task that should be in the config documentation +Configuration,https://backstage.io/docs/features/software-templates/configuration,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to configure a template +Adding your own Templates,https://backstage.io/docs/features/software-templates/adding-templates,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to add a template +Writing Templates,https://backstage.io/docs/features/software-templates/writing-templates,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",The anatomy of a template and how to write one. +Input Examples,https://backstage.io/docs/features/software-templates/input-examples,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Anatomy of template input components. Could be a mini-cookbook or a section of the config instructions for Templates +Builtin actions,https://backstage.io/docs/features/software-templates/builtin-actions,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Describes how to migrate a fetch action from a one fetch action to another. Not clear why this is important; should give some more context. +Writing Custom Actions,https://backstage.io/docs/features/software-templates/writing-custom-actions,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to create a custom template action +Writing Custom Field Extensions,https://backstage.io/docs/features/software-templates/writing-custom-field-extensions,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",More on customizing templates: creating your own field types +Writing custom step layouts,https://backstage.io/docs/features/software-templates/writing-custom-step-layouts,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Still more on customizing templates: creating your own step layouts +Authorizing parameters steps and actions,https://backstage.io/docs/features/software-templates/authorizing-parameters-steps-and-actions,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Authorization in custom templates +Experimental: Testing out the alpha Scaffolder plugin,https://backstage.io/docs/features/software-templates/testing-scaffolder-alpha,task,administrator,"installation, setup, config",Release Notes,Information about features that are in flux or still in development should have their own documentation separate from the production system. The feature should be described in the Release Notes. +Migrating to v1beta3 templates,https://backstage.io/docs/features/software-templates/migrating-from-v1beta2-to-v1beta3,,administrator,"installation, setup, config",Release Notes,Information about features that are in flux or still in development should have their own documentation separate from the production system. The feature should be described in the Release Notes. +Overview,https://backstage.io/docs/features/search/,concept,administrator; user,use,User Guide,"Intro to the search feature, including its configurability as a plugin" +Getting Started with Search,https://backstage.io/docs/features/search/getting-started,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Installing and configuring frontend and backend search +Search Concepts,https://backstage.io/docs/features/search/concepts,concept,administrator; user,"deployment, use",Technical Overview,Description of search system components. +Search Architecture,https://backstage.io/docs/features/search/architecture,concept,all,"decision, deployment",Architecture Overview,Description of search architecture +Search Engines,https://backstage.io/docs/features/search/search-engines,concept,administrator; user,deployment,Architecture Overview,Describes search backends available by default +How-To guides,https://backstage.io/docs/features/search/how-to-guides,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to deploy a custom search backend +Overview,https://backstage.io/docs/features/techdocs/,concept,all,"decision, deployment",Architecture Overview,Intro to tech docs feature +Getting Started,https://backstage.io/docs/features/techdocs/getting-started,task,administrator; user,"installation, setup, config","Installation, Setup, and Config Guide",Install and config instructions for the TechDoc frontend and backend plugins +Concepts,https://backstage.io/docs/features/techdocs/concepts,concept,administrator; user,"deployment, use","Architecture Overview, Installation Guide",Describes the TechDocs plugin component architecture. +TechDocs Addons,https://backstage.io/docs/features/techdocs/addons,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Describes how to install and configure add-ons to the TechDocs plugin +TechDocs Architecture,https://backstage.io/docs/features/techdocs/architecture,concept,administrator; user,deployment,Architecture Overview,TechDocs architecture block diagrams. +Creating and Publishing Documentation,https://backstage.io/docs/features/techdocs/creating-and-publishing,task,user,use,User Guide,How to add existing docs or create a new doc in TechDcos +TechDocs Configuration Options,https://backstage.io/docs/features/techdocs/configuration,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide",A description in an example YAML file of the TechDocs configuration parameters. Don’t know if it’s comprehensive or not. +Using Cloud Storage for TechDocs generated files,https://backstage.io/docs/features/techdocs/using-cloud-storage,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to set up TechDocs on major cloud services +Configuring CI/CD to generate and publish TechDocs sites,https://backstage.io/docs/features/techdocs/configuring-ci-cd,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to automate TechDocs publication in CI/CD +TechDocs CLI,https://backstage.io/docs/features/techdocs/cli,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Reference and how-to information on using the CLI. A bit of a catch-all; should be parceled out in more focused docs. +How-To guides,https://backstage.io/docs/features/techdocs/how-to-guides,task,administrator; user,"deployment, use",Recipe,How-tos for various TechDocs tasks. probably partly redundant with other pages. +Troubleshooting,https://backstage.io/docs/features/techdocs/troubleshooting,task,administrator; user,"deployment, use",Maintenance Guide; User Guide,How to solve several trouble scenarios +FAQ,https://backstage.io/docs/features/techdocs/faqs,concept,administrator; user,"deployment, use",KB,Info about the TechDocs plugin. Probably partly redundant with other pages. +Integrations,,,,,, +Overview,https://backstage.io/docs/integrations/,concept,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Intro to integrations. Needs to be expanded. There are about a dozen listed integrations with common cloud providers and software repos. This could be its own supplement to the installation guide or a chapter or appendix. It's almost certain to be needed for any major installation. +Plugins,,,,,, +Intro to plugins,https://backstage.io/docs/plugins/,concept,administrator,deployment,Architecture Overview,"This introduction needs to be expanded (though that material might exist elsewhere). There are pointers here mostly to contributor actions. ""Contributing a plugin"" needs to be its own separate document on the GitHub site." +Existing plugins,https://backstage.io/docs/plugins/existing-plugins,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide",This is a pointer to the plugin catalog. The catalog should be an appendix to the installation and config guide. +Create a Backstage Plugin,https://backstage.io/docs/plugins/create-a-plugin,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",This is actually a brief description of how to install a plugin on an existing Backstage instance. +Plugin Development,https://backstage.io/docs/plugins/plugin-development,concept,"contributor, admin","contribute, maintenance",Contributor reference,A brief outline of how to develop a plugin. Should go in the contributor guide. +Structure of a Plugin,https://backstage.io/docs/plugins/structure-of-a-plugin,reference,"contributor, admin","contribute, maintenance",Contributor reference,Description of the structure of a plugin. +Integrate into the Software Catalog,https://backstage.io/docs/plugins/integrating-plugin-into-software-catalog,task,contributor,contribute,Contributor reference,"Describes how to add a plugin to the entities page on a Backstage instance. Described as ""advanced"" and ""experimental""." +Integrating Search into a plugin,https://backstage.io/docs/plugins/integrating-search-into-plugins,task,contributor,contribute,Contributor reference,Instructions for implementing search in a plugin. +Composability System,https://backstage.io/docs/plugins/composability,concept,contributor,contribute,Contributor reference,How plugins talk to each other using React extension. Contains some instructional code that should be separated into a procedure. +Customization (Experimental),https://backstage.io/docs/plugins/customization,task,"contributor, user","contribute, use","Contributor reference, User guide","How to customize a plugin. Instructions for both contributor (plugin developer) and a short snippet for a developer to use in an existing installation. Labeled ""experimental""." +Plugin Analytics,https://backstage.io/docs/plugins/analytics,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide","Conceptual, reference, and (mostly) task information about using a supplied analytics API to collect usage data on Backstage." +Feature Flags,https://backstage.io/docs/plugins/feature-flags,task,administrator; user,"installation, setup, config","Installation, Setup, and Config Guide","How to set features flags to define plugin behavior, both in plugin code and from the Backstage application." +Proxying,https://backstage.io/docs/plugins/proxying,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to set up an HTTP proxy to reach backend services from the Backstage frontend +Backend plugins,https://backstage.io/docs/plugins/backend-plugin,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",Instructions for an admin to create and configure a backend plugin. This is one of those pieces of content that spans admin and contributor. +Call Existing API,https://backstage.io/docs/plugins/call-existing-api,task,administrator; user,"installation, setup, config","Installation, Setup, and Config Guide",How to call an arbitrary API from the Backstage frontend +URL Reader,https://backstage.io/docs/plugins/url-reader,task,contributor,contribute,Contributor reference,How to use the Backstage URL reader API to securely read files from a plugin. +Testing with Jest,https://backstage.io/docs/plugins/testing,concept,contributor,contribute,Contributor reference,A description of the infrastructure (Jest) and principles to use when writing unit tests for plugins. +Publish private,https://backstage.io/docs/plugins/publish-private,,,,,"""TODO""" +Add to Marketplace,https://backstage.io/docs/plugins/add-to-marketplace,task,contributor,contribute,Contributor reference,How to add a plugin to the plugin library listed in the documentation +Observability,https://backstage.io/docs/plugins/observability,reference,contributor,contribute,Contributor reference,A brief overview of some logging mechanisms. Covered elsewhere. +Configuration,,,,,, +Static Configuration in Backstage,https://backstage.io/docs/conf/,reference,contributor,"contribute, maintenance",Contributor reference,These sections describe the static configuration files for plugins and how they're combined into the configuration for a Backstage implementation. +Reading Backstage Configuration,https://backstage.io/docs/conf/reading,reference,contributor,"contribute, maintenance",Contributor reference,These sections describe the static configuration files for plugins and how they're combined into the configuration for a Backstage implementation. +Writing Backstage Configuration Files,https://backstage.io/docs/conf/writing,reference,contributor,"contribute, maintenance",Contributor reference,These sections describe the static configuration files for plugins and how they're combined into the configuration for a Backstage implementation. +Defining Configuration for your Plugin,https://backstage.io/docs/conf/defining,reference,contributor,"contribute, maintenance",Contributor reference,These sections describe the static configuration files for plugins and how they're combined into the configuration for a Backstage implementation. +Auth and identity,,,,,, +Authentication in Backstage,https://backstage.io/docs/auth/,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide","How to configure authentication. There are at least 14 individual pages for various providers giving detailed instructions for these providers: ""https://backstage.io/docs/auth/atlassian/provider"" and so on." +Sign-in Identities and Resolvers,https://backstage.io/docs/auth/identity-resolver,reference,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to set up identities for authorization. Probably useful to plugin contributors as well. +OAuth and OpenID Connect,https://backstage.io/docs/auth/oauth,concept,"contributor, admin","contribute, maintenance","Contributor reference, User guide",Describes how tokens are used by Backstage for third-party services. Includes a sequence diagram. +OIDC provider from scratch,https://backstage.io/docs/auth/oidc,task,"contributor, admin",contribute,Contributor reference,How to use Open ID Connect (OIDC) to connect to Backstage. +Contributing New Providers,https://backstage.io/docs/auth/add-auth-provider,task,contributor,contribute,Contributor reference,How to add support for a new authentication provider. Recommended solely for contributors. +Service to Service Auth,https://backstage.io/docs/auth/service-to-service-auth,task,contributor,contribute,Contributor reference,How to set up a plugin to authenticate another service or plugin. +Troubleshooting Auth,https://backstage.io/docs/auth/troubleshooting,task,"contributor, admin",contribute,"Installation, Setup, and Config Guide",Troubleshooting various authentication problems. These span development of plugins to administration of Backstage instances. +Glossary,https://backstage.io/docs/auth/glossary,reference,all,any,,A glossary of terms for authentication. +Permissions,,,,,, +Overview,https://backstage.io/docs/permissions/overview,concept,all,deployment,Architecture Overview,"An introduction to authorization in Backstage, with a flow diagram." +Concepts,https://backstage.io/docs/permissions/concepts,reference,"contributor, admin","contribute, maintenance",Contributor reference,A glossary of authorization terms. +Getting Started,https://backstage.io/docs/permissions/getting-started,task,"contributor, admin","contribute, maintenance",Contributor reference,How to set up authorization in a Backstage plugin. +Writing a permission policy,https://backstage.io/docs/permissions/writing-a-policy,task,"contributor, admin","contribute, maintenance",Contributor reference,How to write a permission policy in a Typescript file. +Frontend Integration,https://backstage.io/docs/permissions/frontend-integration,task,"contributor, admin","contribute, maintenance",Contributor reference,An example showing what to do when frontend permission policy needs to be set. +Defining custom permission rules,https://backstage.io/docs/permissions/custom-rules,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to set up a custom rule outside the context of a plugin. +1. Tutorial setup,https://backstage.io/docs/permissions/plugin-authors/01-setup,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. +2. Adding a basic permission check,https://backstage.io/docs/permissions/plugin-authors/02-adding-a-basic-permission-check,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. +3. Adding a resource permission check,https://backstage.io/docs/permissions/plugin-authors/03-adding-a-resource-permission-check,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. +4. Authorizing access to paginated data,https://backstage.io/docs/permissions/plugin-authors/04-authorizing-access-to-paginated-data,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. +5. Frontend Components with Authorization,https://backstage.io/docs/permissions/plugin-authors/05-frontend-authorization,task,contributor,contribute,Contributor reference,Tutorial on setting up authorization for a plugin. +Deployment,,,,,, +Overview,https://backstage.io/docs/deployment/,concept,administrator,deployment,"Installation, Setup, and Config Guide",Introduction to deploying a Backstage instance. +Scaling,https://backstage.io/docs/deployment/scaling,concept,administrator,deployment,"Installation, Setup, and Config Guide",Brief discussion of how to scale Backstage across an org +Docker,https://backstage.io/docs/deployment/docker,task,administrator,deployment,"Installation, Setup, and Config Guide",How to deploy using Docker. +Kubernetes,https://backstage.io/docs/deployment/k8s,task,administrator,deployment,"Installation, Setup, and Config Guide",Fairly extensive instructions on how to deploy Backstage using Docker on Kubernetes +Heroku,https://backstage.io/docs/deployment/heroku,task,administrator,deployment,"Installation, Setup, and Config Guide",Deploying using Heroic +Koyeb,https://backstage.io/docs/deployment/koyeb,task,administrator,deployment,"Installation, Setup, and Config Guide",Deploying using Kobe +AWS Fargate via Flightcontrol,https://backstage.io/docs/deployment/flightcontrol,task,administrator,deployment,"Installation, Setup, and Config Guide",Deploying on AWS using Flightcontrol +Designing for Backstage,,,,,, +Design,https://backstage.io/docs/dls/design,concept,contributor,contribute,Contributor overview,Introduction to the Backstage OSS project. +Component Design Guidelines,https://backstage.io/docs/dls/component-design-guidelines,concept,contributor,contribute,Contributor reference,Visual design guidelines for components +Contributing to Storybook,https://backstage.io/docs/dls/contributing-to-storybook,task,contributor,contribute,Contributor reference,How to add a control to the Backstage Storybook catalog +Figma,https://backstage.io/docs/dls/figma,reference,contributor,contribute,Contributor reference,Link to the Figma component library for Backstage +API Reference,,,,,, +Utility APIs,https://backstage.io/docs/api/utility-apis,task,contributor,contribute,Contributor reference,Describes the infrastructure for creating and using APIs that operate between plugins. +Package Index,https://backstage.io/docs/reference/,reference,contributor,contribute,Contributor reference,A lengthy catalog of APIs +Deprecations,https://backstage.io/docs/api/deprecations,reference,all,any,,Describes deprecated elements in Backstage. Deprecations should be noted in reference material and described in release notes. +Tutorials,,,,,, +Future developer journey,https://backstage.io/docs/tutorials/journey,task,"contributor, admin",contribute,Recipe,"Extended example about a fictional developer adding a new plugin to an installation, then to the project" +Adding Custom Plugin to Existing Monorepo App,https://backstage.io/docs/tutorials/quickstart-app-plugin,task,administrator,deployment,Recipe,How to develop a plugin in an existing Backstage installation (app) +React Router 6.0 Migration,https://backstage.io/docs/tutorials/react-router-stable-migration,task,administrator,"installation, setup, config",Release Notes,"How to upgrade to a newer version of React router. A version-specific procedure that should be hidden from general admin procedures. Should have been a release-specific task, if necessary at all" +Package Role Migration,https://backstage.io/docs/tutorials/package-role-migration,task,administrator,"installation, setup, config",Release Notes,"Another transitional step that should be part of a version upgrade, not a user tutorial." +Migrating away from @backstage/core,https://backstage.io/docs/tutorials/migrating-away-from-core,task,administrator,"installation, setup, config",Release Notes,Another refactoring migration. Remove from tutorials. +Configuring Plugin Databases,https://backstage.io/docs/tutorials/configuring-plugin-databases,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide","I could see putting this in a recipe guide or a config guide, plugin-specific or otherwise. Not a tutorial." +Switching Backstage from SQLite to PostgreSQL,https://backstage.io/docs/tutorials/switching-sqlite-postgres,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to change the default DB from SQLite to PostgreSQL. This should be in the basic configuration guide. +Using the Backstage Proxy from Within a Plugin,https://backstage.io/docs/tutorials/using-backstage-proxy-within-plugin,task,administrator,"installation, setup, config","Installation, Setup, and Config Guide",How to access an external API using a proxy. A plugin configuration task. +Migration to Yarn 3,https://backstage.io/docs/tutorials/yarn-migration,task,administrator,deployment,Release Notes,Another release-specific migration. Remove from tutorials. +Architecture Decision Records (ADRs),,,,,, +Overview,https://backstage.io/docs/architecture-decisions/,concept,"contributor, admin",deployment,Architecture Overview,"An intro to architectural decision records (ADRs). Potentially part of an architecture overview. Could be omitted from the user doc altogether, though. Primarily of interest to contributors." +ADR001: Architecture Decision Record (ADR) log,https://backstage.io/docs/architecture-decisions/adrs-adr001,concept,contributor,contribute,Contributor reference,Meta ADR about where to store ADRs. +ADR002: Default Software Catalog File Format,https://backstage.io/docs/architecture-decisions/adrs-adr002,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR003: Avoid Default Exports and Prefer Named Exports,https://backstage.io/docs/architecture-decisions/adrs-adr003,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR004: Module Export Structure,https://backstage.io/docs/architecture-decisions/adrs-adr004,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR005: Catalog Core Entities,https://backstage.io/docs/architecture-decisions/adrs-adr005,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR006: Avoid React.FC and React.SFC,https://backstage.io/docs/architecture-decisions/adrs-adr006,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR007: Use MSW to mock http requests,https://backstage.io/docs/architecture-decisions/adrs-adr007,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR008: Default Catalog File Name,https://backstage.io/docs/architecture-decisions/adrs-adr008,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR009: Entity References,https://backstage.io/docs/architecture-decisions/adrs-adr009,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR010: Use the Luxon Date Library,https://backstage.io/docs/architecture-decisions/adrs-adr010,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR011: Plugin Package Structure,https://backstage.io/docs/architecture-decisions/adrs-adr011,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR012: Use Luxon.toLocaleString and date/time presets,https://backstage.io/docs/architecture-decisions/adrs-adr012,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +ADR013: Proper use of HTTP fetching libraries,https://backstage.io/docs/architecture-decisions/adrs-adr013,concept,contributor,contribute,Contributor reference,Information about a particular design decision. +FAQ,,,,,, +FAQ,https://backstage.io/docs/FAQ,reference,all,any,KB,"This is a fairly robust FAQ. I usually recommend doing away with a FAQ on the grounds that it's a last resort for someone looking for information. Distribute its topics to where they belong in the documentation. Use a knowledge base (similar, but longer-format articles with conceptual information only) for miscellaneous, indexed, conceptual information." +Experimental Backend System,,,,,, +Introduction,https://backstage.io/docs/backend-system/,concept,"contributor, admin",deployment,Contributor reference,"Information about a refactoring of existing functionality should be kept in the developer (contributor) discussion until it is deployed, at which point it should be documented in the release notes. Mentions of timing (""this component is in alpha""; ""currently this works like this""; ""we plan to ..."") should be avoided entirely in the product regular documentation. Version-specific information should be documented at the time of release in the release notes. If the change affects functionality, the new functionality should replace the old in the documentation set starting at the new version of the doc." +Overview,https://backstage.io/docs/backend-system/architecture/index,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" +Services,https://backstage.io/docs/backend-system/architecture/services,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" +Plugins,https://backstage.io/docs/backend-system/architecture/plugins,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" +Extension Points,https://backstage.io/docs/backend-system/architecture/extension-points,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" +Modules,https://backstage.io/docs/backend-system/architecture/modules,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" +Naming Patterns,https://backstage.io/docs/backend-system/architecture/naming-patterns,concept,"contributor, admin",deployment,Contributor reference,"See notes on the ""Backend System"" intro, https://backstage.io/docs/backend-system/" +Accessibility,,,,,, +Backstage Accessibility,https://backstage.io/docs/accessibility/,task,contributor,contribute,Contributor reference,How to incorporate accessibility into contributed software components \ No newline at end of file