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

Instructions for how to turn on GitHub actions could be in createGithubPagesAction #1669

Open
kellijohnson-NOAA opened this issue Nov 21, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@kellijohnson-NOAA
Copy link

Proposal

It would be so great if you could add the instructions for how to turn on GitHub pages to the GitHub action file created by createGithubPagesAction(). For example, I recently used a GitHub template to create a repository and immediately got an email notification saying a GitHub action had failed. If the instructions on how to turn on GitHub pages had been in the workflow I personally would have been able to fix the broken action sooner. I eventually was able to find the instructions both on your site and the template site but I still would appreciate them being written as comments in the action file itself.

Additional notes

I am happy to submit a pull request for this feature if it is wanted.

@kellijohnson-NOAA kellijohnson-NOAA added the enhancement New feature or request label Nov 21, 2024
@choldgraf
Copy link
Collaborator

Pull request welcome! I think this would probably best be in the jupyter book repo if you're using JB for your workflow. We are using JB for tutorials and more end user facing docs, and mystmd for more reference and developer docs. Would you like to open a PR against the "next" branch in jupyter book?

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