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

Change how documentation is built #147

Open
drybjed opened this issue Jun 21, 2016 · 2 comments
Open

Change how documentation is built #147

drybjed opened this issue Jun 21, 2016 · 2 comments

Comments

@drybjed
Copy link
Member

drybjed commented Jun 21, 2016

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:

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.

@ypid
Copy link
Member

ypid commented Jun 21, 2016

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

ypid commented Jul 1, 2016

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.

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