Matei David
a5e27d5c1d
* Add TechdocsMetadata type in backend plugin endpoint * Introduce TechDocsMetadata type in frontend * Add changeset * Remove old thennable metadata resp * Address PR feedback - Remove explicit type annotation on TechDocsMetadata - Reintroduce res.send instead of throwing an error - Change logger info to logger error * Add TechDocsMetadata type in frontend plugin * Commit yarn.lock * Introduce JSON5 and remove parsing in local pub Signed-off-by: Matei David <matei.david.35@gmail.com>
techdocs-backend
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
most convenient when developing the techdocs backend plugin itself.
To evaluate TechDocs and have a greater amount of functionality available, instead do
# in one terminal window, run this from from the very root of the Backstage project
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
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.