search

jupyter-book / mystmd

Command line tools for working with MyST Markdown.
https://mystmd.org/guide
MIT License
219 stars 64 forks source link

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

Open kellijohnson-NOAA opened 3 days ago

kellijohnson-NOAA commented 3 days ago

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.

choldgraf commented 3 days ago

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?