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

Use @backstage/plugin-techdocs-node instead of @backstage/techdocs-common

Browse Source 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2022-03-03 13:33:47 +01:00
parent 84a8788794
commit 91bf1e6c1a
34 changed files with 54 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs-node/README.md
+5 -5
View File
@@ -1,15 +1,15 @@
# @backstage/techdocs-common
# @backstage/plugin-techdocs-node
Common functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli
Common node.js functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli
This package is used by `techdocs-backend` to serve docs from different types of publishers (Google GCS, Local, etc.).
It is also used to build docs and publish them to storage, by both `techdocs-backend` and `techdocs-cli`.
## Usage
Create a preparer instance from the [preparers available](/packages/techdocs-common/src/stages/prepare) at which takes an Entity instance.
Run the [docs generator](/packages/techdocs-common/src/stages/generate) on the prepared directory.
Publish the generated directory files to a [storage](/packages/techdocs-common/src/stages/publish) of your choice.
Create a preparer instance from the [preparers available](/plugins/techdocs-node/src/stages/prepare) at which takes an Entity instance.
Run the [docs generator](/plugins/techdocs-node/src/stages/generate) on the prepared directory.
Publish the generated directory files to a [storage](/plugins/techdocs-node/src/stages/publish) of your choice.
Example: