mkdocs-techdocs-core
mkdocs-techdocs-core copied to clipboard
backstage
Manage multiple techdocs in the same repository.
We develop in a mono-repository. Some teams, such as the frontend, backend, and QA teams, work together. We expect to manage two documents in the same repository.
I read those documents. However, I couldn't find the solution.
It would be nice to have a hierarchical structure like this.
$ tree .
.
├── README.md
├── backend-team
│ ├── README.md
│ ├── docs
│ └── mkdocs.yaml
├── backstage-promotion
│ ├── README.md
│ ├── docs
│ └── mkdocs.yaml
├── catalog-info.yaml
└── frontend-team
├── README.md
├── docs
└── mkdocs.yaml
Set the backstage.io/techdocs-ref annotation on your catalog component to the directory where your mkdocs.yaml is. So rather than the default, dir:., you want something like dir:backstage-team for one component and dir:frontend-team for another.
