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
This commit is contained in:
Stefan Ålund
2020-07-15 08:57:25 +02:00
committed by GitHub
parent 982bacb167
commit 8ec6ed5170
53 changed files with 713 additions and 26 deletions
+44
View File
@@ -0,0 +1,44 @@
# [Backstage](https://backstage.io)
![headline](../headline.png)
## What is Backstage?
[Backstage](https://backstage.io/) is an open platform for building developer
portals. Its based on the developer portal weve been using internally at
Spotify for over four years. Backstage can be as simple as a services catalog or
as powerful as the UX layer for your entire tech infrastructure.
For more information go to [backstage.io](https://backstage.io) or join our
[Discord chatroom](https://discord.gg/EBHEGzX).
### Features
- Create and manage all of your organizations software and microservices in one
place.
- Services catalog keeps track of all software and its ownership.
- Visualizations provide information about your backend services and tooling,
and help you monitor them.
- A unified method for managing microservices offers both visibility and
control.
- Preset templates allow engineers to quickly create microservices in a
standardized way
([coming soon](https://github.com/spotify/backstage/milestone/11)).
- Centralized, full-featured technical documentation with integrated tooling
that makes it easy for developers to set up, publish, and maintain alongside
their code ([coming soon](https://github.com/spotify/backstage/milestone/15)).
### Benefits
- For _engineering managers_, it allows you to maintain standards and best
practices across the organization, and can help you manage your whole tech
ecosystem, from migrations to test certification.
- For _end users_ (developers), it makes it fast and simple to build software
components in a standardized way, and it provides a central place to manage
all projects and documentation.
- For _platform engineers_, it enables extensibility and scalability by letting
you easily integrate new tools and services (via plugins), as well as
extending the functionality of existing ones.
- For _everyone_, its a single, consistent experience that ties all your
infrastructure tooling, resources, standards, owners, contributors, and
administrators together in one place.