docs icon indicating copy to clipboard operation
docs copied to clipboard

Change how documentation is built

Open drybjed opened this issue 9 years ago • 2 comments

At the moment, the DebOps documentation located at http://docs.debops.org/ is built using this repository and git submodules. Unfortunately, this presents two problems:

  • with more and more submodules, build time is getting longer. Eventually we will hit the limit on https://readthedocs.org/
  • the project documentation cannot be easily packaged (see https://github.com/debops/docs/issues/132) because it exists scattered in multiple git repositories

Recently, documentation management was improved by adding a separate bot that updates the git repository with submodules and pushes the changes back. What if, instead, the bot would get all the changes in different repositories (basically what is done right now) and copied them to a new, separate repository, say debops/debops-doc. Then this single repository could be used as the base for documentation located at http://docs.debops.org/ as well as be easily packaged. This could probably be done with preserved git history as well.

drybjed avatar Jun 21 '16 16:06 drybjed

with more and more submodules, build time is getting longer. Eventually we will hit the limit on https://readthedocs.org/

So the problem is the time it takes to clone down all the repos? I guess that takes some time.

Sounds like a good idea. I think you can give that a try.

ypid avatar Jun 21 '16 21:06 ypid

This is related to #91 but since upstream has not addressed the issue yet I think we can ignore it. There should be a more flexible way to specify links to the source file.

ypid avatar Jul 01 '16 09:07 ypid