David Tuite
03e264519a
Pasting a URL like `https://github.com/RoadieHQ/sample-service/blob/master/catalog-info-1.yaml` into the Register Existing Component input creates an Entity with the the `backstage.io/managed-by-location` annotation set to the `type` of `url. The TechDocs perparer does not handle this type. ```ts switch (type) { case 'github': case 'gitlab': case 'azure/api': { // ... } case 'file': // ... default: throw new InputError(`Unable to resolve location type ${type}`); } } ``` Thus, docs are never generated and we see the following error when trying to view then in Backstage. ``` InputError: Unable to resolve location type url at DirectoryPreparer.resolveManagedByLocationToDir (webpack-internal:///../../node_modules/@backstage/plugin-techdocs-backend/src/techdocs/stages/prepare/dir.ts:63:15) at DirectoryPreparer.prepare (webpack-internal:///../../node_modules/@backstage/plugin-techdocs-backend/src/techdocs/stages/prepare/dir.ts:73:51) at DocsBuilder.build (webpack-internal:///../../node_modules/@backstage/plugin-techdocs-backend/src/service/helpers.ts:74:45) at eval (webpack-internal:///../../node_modules/@backstage/plugin-techdocs-backend/src/service/router.ts:141:25) at processTicksAndRejections (internal/process/task_queues.js:93:5) ``` This may not be the correct solution. An alternative solution would be to ensure that pasted URLs end up with the `type` of `github` rather than `url`.
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 building and serving of your docs without having to use another service and hosting provider. To use it set your techdocs storageUrl in your app-config.yml to http://localhost:7000/api/techdocs/static/docs.
techdocs:
storageUrl: http://localhost:7000/api/techdocs/static/docs
Extending techdocs-backend
Currently the build process of techdocs-backend is split up in these three stages.
- Preparers
- Generators
- Publishers
Preparers read your entity data and creates a working directory with your documentation source code. For example if you have set your backstage.io/techdocs-ref to github:https://github.com/backstage/backstage.git it will clone that repository to a temp folder and pass that on to the generator.
Generators takes the prepared source and runs the techdocs-container on it. It then passes on the output folder of that build to the publisher.
Publishers gets a folder path from the generator and publish it to your storage solution. Currently the only built in storage solution is a folder called static/docs inside the techdocs-backend plugin.
Any of these can be extended. If we want to publish to a external static file server using rsync for example that can be done by creating a rsync publisher. (Keep in mind that if you want techdocs-backend to initiate a build this would also require techdocs-backend to act as a proxy, which is not yet implemented.)