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.
- Overview
- What is Backstage?
- Backstage architecture
- Architecture and terminology
- Roadmap
- Getting started
- Running Backstage locally
- Installation
- Local development
- Demo deployment
- Production deployments
- Create an App
- App configuration
- Deployment scenarios
- Features
- Software Catalog
- Software creation templates
- Overview
- Adding templates
- Extending the Scaffolder:
- Docs-like-code
- Plugins
- Authentication and identity
- Designing for Backstage
- API references
- TypeScript API
- Backend APIs
- Tutorials
- 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
- Contribute
- Support
- FAQ