Skip to main content

Creating and publishing your docs

This section will guide you through how to:

Prerequisites​

Create a basic documentation setup​

If you have an existing repository that you'd like to add documentation to, skip to the Enable documentation for an already existing entity setup section below. Otherwise, continue reading to create a new software entity including documentation from scratch.

Use any software template​

TechDocs is built on top of the docs like code approach. This, in short, means that you should keep documentation close to the code.

Your Backstage app has a set of software templates added by default. All of these software templates include everything you need to get your TechDocs site up and running and to start writing your documentation.

If you have created software templates that do not include documentation by default, we highly recommend you to set that up. Follow our how-to guide How to add documentation setup to your software templates to get started.

Use the documentation template​

There could be some situations where you don't want to keep your docs close to your code, but still want to publish documentation - for example, an onboarding tutorial. For this use case, we have put together a documentation template. Your Backstage instance should by default have a documentation template added. If not, copy the catalog locations from the create-app template to add the documentation template. The template creates a component with only TechDocs configuration and default markdown files, and is otherwise empty.

Documentation Template

Create an entity from the documentation template and you will get the needed setup for free.

Enable documentation for an already existing entity​

Prerequisites:

Create an mkdocs.yml file in the root of your repository with the following content:

site_name: 'example-docs'

nav:
  - Home: index.md

plugins:
  - techdocs-core

Note - The plugins section above is optional. Backstage automatically adds the techdocs-core plugin to the mkdocs file if it is missing. This functionality can be turned off with a configuration option in Backstage.

Update your component's entity description by adding the following lines to its catalog-info.yaml in the root of its repository:

metadata:
  annotations:
    backstage.io/techdocs-ref: dir:.

The backstage.io/techdocs-ref annotation is used by TechDocs to download the documentation source files for generating an entity's TechDocs site.

Create a /docs folder in the root of your repository with at least an index.md file in it. (If you add more markdown files, make sure to update the nav in the mkdocs.yml file to get a proper navigation for your documentation.)

Note - Although docs is a popular directory name for storing documentation, it can be renamed to something else and can be configured by mkdocs.yml. See https://www.mkdocs.org/user-guide/configuration/#docs_dir

The docs/index.md can for example have the following content:

# example docs

This is a basic example of documentation.

Commit your changes, open a pull request and merge. You will now get your updated documentation next time you run Backstage!

Writing and previewing your documentation​

Using the techdocs-cli you can preview your docs inside a local Backstage instance and get live reload on changes. This is useful when you want to preview your documentation while writing.

To do this you can run:

cd /path/to/docs-repository/
npx @techdocs/cli serve