diff --git a/appendix/how-to-contribute.md b/appendix/how-to-contribute.md index f001d1e8b..b6f89c097 100644 --- a/appendix/how-to-contribute.md +++ b/appendix/how-to-contribute.md @@ -1,15 +1,11 @@ -# Pythia Foundations Contributor's Guide - -```{note} -This content is under construction! -``` +# Contributing to Foundations General information on how to contribute to any Project Pythia repository -may be found [here][pythia contributor's guide]. +may be found in the [Contributing to Project Pythia](https://projectpythia.org/contributing) guide. -This page will eventually contain a full guide to contributing to Project Pythia. As GitHub Pull Requests are an important part of contributing to Pythia, this guide will cross-reference tutorials on GitHub and Pull Requests. +As GitHub Pull Requests are an important part of contributing to Pythia, this guide will cross-reference tutorials on GitHub and Pull Requests. -If you need to comment on anything in Pythia Foundations you feel needs work, you can use the "open issue" or "suggest edit" buttons at the top of any Pythia Foundations page. These buttons appear when you hover over the GitHub Octocat logo. Clicking on these buttons will take you to the relevant page on GitHub, where the entirety of the Pythia Foundations material is hosted. In order to actually suggest changes, you must have a free GitHub account, as listed in the GitHub section of Pythia Foundations. This contributor's guide is strictly for Pythia Foundations; for general Project Pythia contribution guidelines, see the main [Project Pythia Contributor's Guide][pythia contributor's guide]. +If you need to comment on anything in Pythia Foundations you feel needs work, you can use the "open issue" or "suggest edit" buttons at the top of any Pythia Foundations page. These buttons appear when you hover over the GitHub Octocat logo. Clicking on these buttons will take you to the relevant page on GitHub, where the entirety of the Pythia Foundations material is hosted. In order to actually suggest changes, you must have a free GitHub account, as listed in the GitHub section of Pythia Foundations. This guide is strictly for Pythia Foundations; for general Project Pythia contribution guidelines, see the main guide for [Contributing to Project Pythia](https://projectpythia.org/contributing). To quickly provide feedback about minor issues without the use of GitHub, you can also use this [Google Form](https://docs.google.com/forms/d/e/1FAIpQLSeVa1TC9xM-dk7qIE2e8bsgSrIP82yYDNw3wew3J46eREJa4w/viewform?usp=sf_link). @@ -48,18 +44,14 @@ To build the book locally, run the following: ```bash conda activate pythia-book-dev -jupyter-book build . +myst start --execute ``` -Finally, you can view the book by opening the file `_build/html/index.html` with your favorite web browser. On most platforms you can simply run: - -```bash -open _build/html/index.html -``` +Finally, you can view the book by opening the localhost link that should be generated in your terminal. ### Keeping your dev environment up to date -It's good practice to update the packages in your `pythia-book-dev` conda environment frequently to their latest versions, especially if it's been a while since you used it. If the `jupyter-book build .` command above generates error messages, that is a good indication that your conda environment may be out of date. +It's good practice to update the packages in your `pythia-book-dev` conda environment frequently to their latest versions, especially if it's been a while since you used it. If the `myst start --execute` command above generates error messages, that is a good indication that your conda environment may be out of date. To update all packages in the currently activated environment to their latest versions, do this: @@ -67,4 +59,4 @@ To update all packages in the currently activated environment to their latest ve conda update --all ``` -[pythia contributor's guide]: https://projectpythia.org/contributing.html +[Contributing to Project Pythia]: https://projectpythia.org/contributing.html