Patrik Oldsberg
b2319ffe45
Add a `toError` utility function to `@backstage/errors` that converts unknown values to `ErrorLike` objects. If the value is already error-like it is returned as-is. Strings are used directly as the error message, and other values are stringified with a fallback to JSON.stringify to avoid unhelpful `[object Object]` messages. Non-error causes passed to `CustomErrorBase` are now converted and stored using `toError` rather than discarded. Existing `assertError` call sites across the codebase are migrated to `toError`. Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com> Made-with: Cursor
techdocs-backend
This is the backend part of the techdocs plugin.
Getting Started
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:
# From your Backstage root directory
cd packages/backend
yarn start
What techdocs-backend does
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-node 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.