paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 41 Packages Projects Releases Wiki Activity

Text edits for consistency and clarity

Browse Source 
Minor edits

Signed-off-by: Bodil Björklund <bodilb@spotify.com>
This commit is contained in:
Bodil Björklund
2021-09-21 11:25:03 +02:00
parent 26ab175ffd
commit 116dc8759f
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs-backend/README.md
+6 -6
View File
@@ -4,22 +4,22 @@ This is the backend part of the techdocs plugin.
## Getting Started
This backend plugin can be started in a standalone mode from directly in this package
with `yarn start`. However, it will have limited functionality and that process is
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
To evaluate TechDocs and have a greater amount of functionality available, instead do:
```bash
# in one terminal window, run this from from the very root of the Backstage project
# From your Backstage root directory
cd packages/backend
yarn start
```
## What techdocs-backend does
This plugin is the backend part of the techdocs plugin. It 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
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](https://github.com/backstage/backstage/tree/master/packages/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.