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.

Sign up for GitHub

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

Jump to bottom

HTML artifacts for reviewers #1280

Open
woutdenolf opened this issue Jun 16, 2023 · 1 comment
Open

HTML artifacts for reviewers #1280

woutdenolf opened this issue Jun 16, 2023 · 1 comment
Labels
code camp workflows Continuous integration and deployment

Comments

@woutdenolf
Copy link
Contributor

When reviewing PRs you often want to see the rendered documentation. Currently you need to pull the branch and build locally. It would be much more convenient if you could see the documentation build by the CI.
@woutdenolf woutdenolf added code camp workflows Continuous integration and deployment labels Jun 16, 2023
@woutdenolf woutdenolf mentioned this issue Jun 16, 2023
Closed
@woutdenolf
Copy link
Contributor Author

woutdenolf commented Jun 16, 2023 •
edited
Loading

Possible solutions:

  1. github workflow artifacts: html artifact for easy documentation checking of pull requests #1041 (you still need to download the docs and view them locally)
  2. readthedocs.org: https://docs.readthedocs.io/en/stable/pull-requests.html (you will be able to see the docs without the need for downloading but they may be indexed by search engines, a robots.txt may be able to prevent this)
  3. github pages: https://github.com/marketplace/actions/deploy-pr-preview (same as readthedocs)

@woutdenolf woutdenolf mentioned this issue Jun 22, 2023
Merged
@PeterC-DLS PeterC-DLS mentioned this issue Jun 23, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code camp workflows Continuous integration and deployment
Projects
Code Camp June 2023 project
Status: Ready for Review
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

html artifact for easy documentation checking of pull requests woutdenolf/definitions
1 participant
@woutdenolf