backstage / backstage/mkdocs-monorepo-plugin

Respect Gitlinks per Attached Repository

Open
#46 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
400
Forks
80
PR merge metrics
No merged PRs in 30d

Description

Hello dear community, in e.g. mkdocs-material there is nice feature: https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#adding-a-git-repository

By simple config in yaml file:
```
repo_name: Trolololo
repo_url: https://somehost.com/Trololo
edit_uri: "edit/master/docs/"
```
will enable this:
![grafik](https://user-images.githubusercontent.com/6813635/115865195-494f7500-a438-11eb-95fc-fa164691a362.png)
By clicking you are jumping into the Repositroy to exact file.

When I use monorepo no links will be provided.

Please respect config per attached repository.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how attached repositories and their YAML configuration are read, then follow how MkDocs edit links are generated for monorepo pages. Done means each attached repository can provide its own repository and edit-path settings, with links reaching the exact documentation file; the issue does not name a file or test to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.