Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manage multiple techdocs in the same repository. #184

Open
4geru opened this issue Apr 8, 2024 · 2 comments
Open

Manage multiple techdocs in the same repository. #184

4geru opened this issue Apr 8, 2024 · 2 comments

Comments

@4geru
Copy link

4geru commented Apr 8, 2024

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
Copy link

bforbis commented Apr 8, 2024

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
Copy link
Author

4geru commented Apr 18, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants