From 03d7911ad9f84923006f95ff8031a7b35404347d Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Mon, 27 Sep 2021 15:48:07 +0200 Subject: [PATCH 1/2] [TechDocs] Add link to how-to guide Signed-off-by: Emma Indal emma.indahl@gmail.com Signed-off-by: Emma Indal --- plugins/techdocs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/techdocs/README.md b/plugins/techdocs/README.md index c5e8fa6887..4c619c0bd4 100644 --- a/plugins/techdocs/README.md +++ b/plugins/techdocs/README.md @@ -10,4 +10,4 @@ http://backstage.io/docs/features/techdocs/configuration ### TechDocs Storage Api -The default setup of TechDocs assumes your documentation is accessed by reading a page with the format of `///`. If for some reason you want to change this it can be configured by implementing a new techdocs storage API. Do this by implementing TechDocsStorage found in `plugins/techdocs/src/api`. Add your new API to the application in `app/src/apis.ts` (or replace if it's already registered as an API). +The default setup of TechDocs assumes your documentation is accessed by reading a page with the format of `///`. If for some reason you want to change this it can be configured by [implementing a new techdocs storage API](https://backstage.io/docs/features/techdocs/how-to-guides#how-to-implement-your-own-techdocs-apis). From edda769360edecb12dea5629cd567219e655d87f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bodil=20Bj=C3=B6rklund?= Date: Mon, 27 Sep 2021 17:19:54 +0200 Subject: [PATCH 2/2] Minor text edits MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Piggy-backing on this branch to include minor text edits to README. Signed-off-by: Bodil Björklund --- plugins/techdocs/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/techdocs/README.md b/plugins/techdocs/README.md index 4c619c0bd4..6524651bf5 100644 --- a/plugins/techdocs/README.md +++ b/plugins/techdocs/README.md @@ -2,12 +2,12 @@ ## Getting started -Set up Backstage and TechDocs by follow our guide on [Getting Started](../../docs/features/techdocs/getting-started.md). +Set up Backstage and TechDocs by following our guide on [Getting Started](../../docs/features/techdocs/getting-started.md). ## Configuration -http://backstage.io/docs/features/techdocs/configuration +Refer to our [configuration reference](../../docs/features/techdocs/configuration.md) for a complete listing of configuration options. -### TechDocs Storage Api +### TechDocs Storage API -The default setup of TechDocs assumes your documentation is accessed by reading a page with the format of `///`. If for some reason you want to change this it can be configured by [implementing a new techdocs storage API](https://backstage.io/docs/features/techdocs/how-to-guides#how-to-implement-your-own-techdocs-apis). +The default setup of TechDocs assumes that your documentation is accessed by reading a page with the format of `///`. This can be configured by [implementing a new techdocs storage API](https://backstage.io/docs/features/techdocs/how-to-guides#how-to-implement-your-own-techdocs-apis).