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

Automate build of user-guide on CI #8

Open
michael-okeefe opened this issue Mar 28, 2024 · 0 comments
Open

Automate build of user-guide on CI #8

michael-okeefe opened this issue Mar 28, 2024 · 0 comments
Labels
CI-GHAction Pertains to the CI (Github Actions) documentation Improvements or additions to documentation enhancement New feature or request low-priority "Nice to have" but not necessary; prioritize lower

Comments

@michael-okeefe
Copy link
Member

The user guide should be automatically built by the CI (Github Actions) ideally.

We would only need to use an Ubuntu instance. The current build files are in docs/user-guide. Please see the dependencies in docs/user-guide/README.md for guidance on how to set up the system to build.

Some investigation will be required to see if Github allows us to store artifacts (the built PDF) somewhere when using private repositories without a team or enterprise license.

At a later time, we will investigate building the HTML documentation but not yet.

@michael-okeefe michael-okeefe added documentation Improvements or additions to documentation enhancement New feature or request low-priority "Nice to have" but not necessary; prioritize lower CI-GHAction Pertains to the CI (Github Actions) labels Mar 28, 2024
@michael-okeefe michael-okeefe added this to the 2024-08 milestone Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI-GHAction Pertains to the CI (Github Actions) documentation Improvements or additions to documentation enhancement New feature or request low-priority "Nice to have" but not necessary; prioritize lower
Projects
None yet
Development

No branches or pull requests

1 participant