We will shortly be moving to the dedicated backstage org on GitHub. Some of TechDocs packages can make good use of living in separate repositories out of this mono-repo. Note that, our main plugins techdocs and techdocs-backend will stay inside the Backstage mono-repo.
The proposed new repositories are following -
_What is it?_
The Docker container responsible for converting markdown source into static site.
_Current home_
https://github.com/spotify/backstage/tree/master/packages/techdocs-container
_New home_
https://github.com/backstage/techdocs-container
_Benefits of moving to a new repository?_
_Progress_
_What is it?_
CLI for local development of a techdocs site. Currently WIP.
_Current home_
https://github.com/spotify/backstage/tree/master/packages/techdocs-cli
_New home_
https://github.com/backstage/techdocs-cli
_Benefits of moving to a new repository?_
More visibility maybe? This package can use some _love_ and turn out to be a very useful tool. There are no strong reasons to keep it in the mono-repo.
_Progress_
_What is it?_
Core mkdocs plugin used by TechDocs. (Python package)
_Current home_
https://github.com/spotify/backstage/tree/master/packages/techdocs-container/techdocs-core
_New home_
https://github.com/backstage/mkdocs-techdocs-core
_Benefits of moving to a new repository?_
Decoupling releases. Has independent use case in the community. No strong reasons to keep it in the mono-repo.
_Progress_
_What is it?_
MkDocs plugin to support building docs in mono-repo. (Python package)
_Current home_
https://github.com/spotify/mkdocs-monorepo-plugin
_New home_
https://github.com/backstage/mkdocs-monorepo-plugin
This package already exists out of the mono-repo. The benefit of moving this from spotify/ to backstage/ will be keeping all the TechDocs projects close. That is the only benefit as I can see.
_Progress_
@spotify/backstage-core Let us know if there are any comments or concerns. cc @spotify/techdocs-core
Question: While we are at this change, can we rename mkdocs-techdocs-core to add the word plugin?
We already have mkdocs-monorepo-plugin. So we will maintain consistency. And IMO mkdocs-techdocs-core does not convey very well that it is just a MkDocs plugin and not the "core" of techdocs.
@emmaindal @hooloovooo
@stefanalund Let us setup the techdocs-core team on https://github.com/backstage (i.e. invite the members), and then we can setup the repositories needed here. We are ready to do it as soon as possible, and as it fits in the plan. :)
@OrkoHunter you, @emmaindal, @soapraj and @hooloovooo have now been invited. Please let me know if it looks good!
This is 100% complete.馃挜 馃帀
Most helpful comment
@OrkoHunter you, @emmaindal, @soapraj and @hooloovooo have now been invited. Please let me know if it looks good!