Files
backstage/plugins/techdocs-backend
Emma Indal 156421c59a [TechDocs] Update default techdocs docker image to latest version (#7448)
* set default docker image to latest one 0.3.3

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* update extensions docs with new truly sane lists example

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* changeset

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* use consistent tagging for docker image versions

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* update changeset with correct link to tag

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

* update api report

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
2021-10-05 13:57:55 +02:00
..
2021-09-23 10:01:17 +00:00
2021-09-23 10:01:17 +00:00

techdocs-backend

This is the backend part of the techdocs plugin.

Getting Started

This backend plugin can be started in a standalone mode directly from in this package using yarn start. However, it will have limited functionality and that process is most convenient when developing the techdocs backend plugin itself.

To evaluate TechDocs and have a greater amount of functionality available, instead do:

# From your Backstage root directory
cd packages/backend
yarn start

What techdocs-backend does

This provides serving and building of documentation for any entity. To configure various storage providers and building options, see http://backstage.io/docs/features/techdocs/configuration.

The techdocs-backend re-exports the techdocs-common package which has the features to prepare, generate and publish docs. The Publishers are also used to fetch the static documentation files and render them in TechDocs.