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

Use released docs package from renovate to generate docs #108

Open
viceice opened this issue Dec 10, 2021 · 3 comments
Open

Use released docs package from renovate to generate docs #108

viceice opened this issue Dec 10, 2021 · 3 comments
Labels
enhancement New feature or request

Comments

@viceice
Copy link
Member

viceice commented Dec 10, 2021

What would you like to be able to do?

We should use the now released precompiled renovate docs asset instead of the git submodule.
This will speedup docs generation.
Dowside: we need a renovate release to update docs.

Did you already have any implementation ideas?

  • remove submodule
  • add renovate version to a file and let renovate selfupdate
  • download file in get-docs
  • optional allow setting an env to use local docs from renovate repo outside of this repo for debugging
@viceice viceice added the enhancement New feature or request label Dec 10, 2021
@HonkingGoose
Copy link
Collaborator

Dowside: we need a renovate release to update docs.

Don't we already need a Renovate release to publish our docs? Or did the docs site get updated regularly on a cron timer as well?

@viceice
Copy link
Member Author

viceice commented Dec 10, 2021

Currently this repo has the renovate repo as git submodule. So this repo get's updated shortly after a commit on main on renovate repo.
And the update will trigger a docs publish.

@HonkingGoose
Copy link
Collaborator

We should also update the README.md and the contributing.md files, so they explain how to use the released docs package. That way I know how to preview the docs. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants