Skip to content

Commit

Permalink
Incorporate feedback for clarity
Browse files Browse the repository at this point in the history
Co-authored-by: Brian Rose <[email protected]>
  • Loading branch information
dcamron and brian-rose committed Sep 6, 2024
1 parent d607a4e commit 7e3b527
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
5 changes: 4 additions & 1 deletion portal/cookbook-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,12 @@ As always, reach out to a Pythia team member for help with any of these steps!

### Initiate the Cookbook review process

Your Cookbook will be assigned a Cookbook advocate from the Project Pythia maintenance team.
If you haven't already, now is a great time to [contact the Project Pythia team](https://discourse.pangeo.io/c/education/project-pythia/60) to let them know about your new Cookbook. You will be assigned a Cookbook advocate from the Pythia maintenance team.
They will open an issue on your Cookbook repository with the [Cookbook Checklist](cookbook-tasklist.md) for you to document your completion of the above process, plus a few more GitHub-specific steps.
Once you complete this process, your Cookbook will be ready for review and publication!

### Submit your Cookbook to the Gallery

Click the button below to request addition of your Cookbook to the [Project Pythia Cookbook Gallery](https://cookbooks.projectpythia.org).

<span class="d-flex justify-content-center py-4">
Expand Down
8 changes: 5 additions & 3 deletions portal/cookbook-tasklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Once we've marked this entire checklist, [click here to open an issue on Project
---

- [ ] **Confirm you’ve followed the entire Project Pythia [Cookbook Guide](https://projectpythia.org/cookbook-guide.html)**.
Take note especially of the **Develop your cookbook**, **Authorship and the CITATION.cff file**, **Gallery tags**, and **Generate a DOI** sections. **Save the step of making a “release” of your cookbook as the last step of this checklist.**
Take note especially of the [Develop your cookbook](https://projectpythia.org/cookbook-guide.html#develop-your-cookbook), [Authorship and the CITATION.cff file](https://projectpythia.org/cookbook-guide.html#authorship-and-the-citation-cff-file), and [Gallery tags](https://projectpythia.org/cookbook-guide.html#gallery-tags) sections. **Save the [Generate a DOI](https://projectpythia.org/cookbook-guide.html#generate-a-doi) step as the last step of this checklist.**
- [ ] **Confirm that the individual notebooks within your Cookbook adhere to the [notebook template](https://github.com/ProjectPythia/cookbook-template/blob/main/notebooks/notebook-template.ipynb)**.
If the template does not fit your Cookbook’s needs, that’s fine too! Simply let us know here in this issue.
- [ ] **Finalize your Cookbook repository name.**
Expand Down Expand Up @@ -40,8 +40,10 @@ This can be seen in individual Pull Requests as green checkmarks ✅ for importa
- trigger-link-check will fail if links in your content can not be resolved. We can help ignore links that are broken even if they work on manual clicks.
- Code errors in your notebooks themselves
- [ ] **Identify a Maintainer team via GitHub handle(s) in this thread.**
This can be one or more people with availability to check in on this Cookbook, issue fixes to broken content, or with a vision for the future development of the Cookbook.
- [ ] **Finally, release your Cookbook!**
This can be one or more people with availability to check in on this Cookbook, issue fixes to broken content, or with a vision for the future development of the Cookbook. This is typically (but not necessarily) one of the primary authors of the Cookbook.
- [ ] **Link your Cookbook repo to Zenodo for DOI generation**
Follow steps 1-4 under [Generate a DOI](https://projectpythia.org/cookbook-guide.html#generate-a-doi) in the Cookbook Guide. Return here for instructions on step 5, and your final step:
- [ ] **Release your Cookbook!**
- On the right-hand sidebar for your Cookbook repository, click “Create a new release”. If you don’t see this button, you may need to click on the “Releases” header first and “Create” or “Draft” a new release.
![GitHub Repository sidebar section titled "Releases"](https://raw.githubusercontent.com/ProjectPythia/projectpythia.github.io/main/portal/_static/images/4-releases.png "Releases")
- “Choose a tag”, enter a new tag name. This will be the git reference of the snapshot of code that represents this particular release of your Cookbook! We recommend using a name fitting the [CalVer](https://calver.org/) scheme, so something like v2024.06.13 for the date of the release, then choose “+ Create new tag: <your tag name> on publish” and make its Target main (unless you have the knowledge and desire to release from another branch!)
Expand Down

0 comments on commit 7e3b527

Please sign in to comment.