Files

T

David Tuite 7db913e36b Add api-catalog.yaml file (#1822 )

Also added ARD008 to explain the decision. This is linked from
`mkdocs.yaml` and `docs/README.md`.

Co-authored-by: David Tuite <dtuite@gmail.com>

2020-08-05 14:43:06 +02:00

5.3 KiB

Raw Blame History

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.

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
      - Configuring App with plugins
      - Customize the look-and-feel of your App
    - Deployment scenarios
      - Kubernetes
      - Other
- Features
  - Software Catalog
  - 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
- Plugins
  - Overview
  - Existing plugins
  - Creating a new plugin
  - Developing a plugin
  - Structure of a plugin
  - Backends and APIs
  - Testing
    - Overview
  - Publishing
    - Open source and NPM
    - Private/internal (non-open source)
- Authentication and identity
- Designing for Backstage
- API references
  - TypeScript API
  - Backend APIs
    - Backend
- Tutorials
  - Overview
- Architecture Decision Records (ADRs)
- Contribute
- Support
- FAQ

5.3 KiB Raw Blame History

Documentation structure

5.3 KiB

Raw Blame History