backstage/docs/README.md

Documentation structure

Note! This documentation structure is very much work in progress. If (when, really 😆) you find broken links or missing content, please create an issue or, better yet, a pull request.

Plugins

• Overview
  • What is Backstage?
  • Backstage architecture
  • Architect:ure and terminology
  • Roadmap
• Getting started
  • Running Backstage locally
  • Installation
  • Local development
  • Demo deployment
  • Production deployments
    • Create an App
    • App configuration
      • Configuring App with plugins
      • Customize the look-and-feel of your App
    • Deployment scenarios
      • Kubernetes
      • Other
• Features
  • Software Catalog
    • Overview
    • System model
    • YAML File Format
    • Populating the catalog
    • Extending the model
    • External integrations
    • API
  • Software creation templates
    • Overview
    • Adding templates
      • Extending the Scaffolder:
        • Overview
        • Create your own Templater
        • Create your own Publisher
        • Create your own Preparer
  • Docs-like-code
    • Overview
    • Getting Started
    • Concepts
    • Creating and Publishing Documentation
    • FAQ
• Plugins
  • Overview
  • Existing plugins
  • Creating a new plugin
  • Developing a plugin
  • Structure of a plugin
  • Backends and APIs
    • Proxying
    • Backstage backend plugin
    • Call existing API
  • Testing
    • Overview
  • Publishing
    • Open source and NPM
    • Private/internal (non-open source)
• Configuration
  • Overview
  • Reading Configuration
  • Writing Configuration
  • Defining Configuration
• Authentication and identity
  • Overview
  • Add auth provider
  • Auth backend
  • OAuth
  • Glossary
• Designing for Backstage
  • Backstage Design Language System (DLS)
  • Storybook -- reusable UI components
  • Contributing to Storybook
  • Figma resources
• API references
  • TypeScript API
    • Utility APIs
    • Utility API References
    • createPlugin
    • createPlugin-feature-flags
    • createPlugin-router
  • Backend APIs
    • Backend
• Tutorials
  • Overview
• Architecture Decision Records (ADRs)
  • Overview
  • ADR001 - Architecture Decision Record (ADR) log
  • ADR002 - Default Software Catalog File Format
  • ADR003 - Avoid Default Exports and Prefer Named Exports
  • ADR004 - Module Export Structure
  • ADR005 - Catalog Core Entities
  • ADR006 - Avoid React.FC and React.SFC
  • ADR007 - Use MSW for Mocking Network Requests
  • ADR008 - Default Catalog File Name
• Contribute
• Support
• FAQ