Files

T

Stefan Ålund 8ec6ed5170 Documentation skeleton (#1617 )

* Documentation skeleton

* Added ADR list and more

* rm material theme

* Update mkdocs.yml

* Add docs TOC

* Work for plain MD and mkdocs

* Update mkdocs.yml

* Restructuring

* Added roadmap

* Add reference APIs

* move publishing

2020-07-15 08:57:25 +02:00

api

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

architecture-decisions

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

auth

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

dls

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

features

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

getting-started

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

openapi/definitions

[auth]: Add openapi specification (#1309 )

2020-06-16 15:05:42 +02:00

overview

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

plugins

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

reference

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

tutorials

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

contributorheader.png

Contributor Header (#580 )

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

FAQ.md

Update FAQ.md (#1464 )

2020-06-29 14:24:56 +02:00

generate-uml.sh

docs: added plantuml generation script

2020-06-09 18:29:15 +02:00

headline.png

new headline image for README (#1122 )

2020-06-05 10:56:37 +02:00

journey.md

v0.1.1-alpha.8

2020-06-12 22:09:21 +02:00

prettier.config.js

docs: added prettier config

2020-06-09 18:29:15 +02:00

README.md

Documentation skeleton (#1617 )

2020-07-15 08:57:25 +02:00

service_specification.schema.json

chore(docs): more tweaks to the schema

2020-06-17 14:41:10 +02:00

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.

Overview
- What is Backstage?
- 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
  - 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