From 116dc8759fb5a1c53a730c424b836b5379043567 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bodil=20Bj=C3=B6rklund?= Date: Tue, 21 Sep 2021 11:25:03 +0200 Subject: [PATCH] Text edits for consistency and clarity MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Minor edits Signed-off-by: Bodil Björklund --- plugins/techdocs-backend/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/plugins/techdocs-backend/README.md b/plugins/techdocs-backend/README.md index c2a1cb99aa..57bc477f12 100644 --- a/plugins/techdocs-backend/README.md +++ b/plugins/techdocs-backend/README.md @@ -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.