backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
82 stars 61 forks source link

Manage multiple techdocs in the same repository. #184

Closed 4geru closed 4 days ago

4geru commented 2 months ago

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
bforbis commented 2 months ago

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.

4geru commented 2 months ago

Thank you!! I can create the multiple document in the one place 👍 👍

awanlin commented 4 days ago

Closing as this looks resolved 👍