backstage / backstage/mkdocs-monorepo-plugin

Can Monorepo plugin execute other plugins inside respective subrepos?

Open
#73 0 comments 11 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
400
Forks
80
PR merge metrics
No merged PRs in 30d

Description

Hello everyone,

my most useful plugins so far [mkdocstrings](https://mkdocstrings.github.io), and [macros](https://github.com/fralau/mkdocs_macros_plugin/) do not work anymore whithin the subrepo when it is pulled and built by monorepo.

monorepo `mkdocs.yml`:
```mkdocs.yml
plugins:
- monorepo
```

subrepo `mkdocs.yml`:
```yml
plugins:
- macros
- mkdocstrings
```
Added to plugins section under `mkdocs.yml` in the monorepo it would work with a lot of rewriting paths. But as the docs live close to the code in the respective subrepos I want the developers to write docstrings and macros in their own repo's .md pages and see them in their own (local) mkdocs build.

Do I get something wrong about monorepo or is there a possibility to realize this?

Contributor guide

Open the contributing guide

Research direction

Start with the monorepo and subrepo mkdocs.yml examples in the report, then reproduce a local build using the monorepo plugin with macros and mkdocstrings enabled only in the subrepo. Determine whether subrepo plugin execution is supported or what integration design is needed; done means the subrepo plugins work without rewriting paths.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.