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

Add workflow to deploy docs preview on PR #2029

Open
rly opened this issue Mar 26, 2024 · 0 comments
Open

Add workflow to deploy docs preview on PR #2029

rly opened this issue Mar 26, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request generator-doc

Comments

@rly
Copy link
Contributor

rly commented Mar 26, 2024

Is your feature request related to a problem? Please describe.

It would be nice to preview how a change to the docs looks without having to build the docs locally. You can do this using https://github.com/rossjrw/pr-preview-action. The NWB team uses it for their github pages page - example workflow here https://github.com/NeurodataWithoutBorders/nwb_hackathons/blob/main/.github/workflows/test-pages-build.yml

I think it will run on every PR, and since most PRs don't change the docs here, this is probably unnecessary. I would configure this to run only if something in the docs folder has been changed.

How important is this feature?
• Low - it's an enhancement but not crucial for work

When will use cases depending on this become relevant?
• Long-term - 6 months - 1 year

@nlharris nlharris added enhancement New feature or request generator-doc labels Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request generator-doc
Projects
None yet
Development

No branches or pull requests

3 participants