From 2b78b9830636b9bb4b466776b00fa9a77c38218d Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Thu, 17 Apr 2025 08:23:29 -0600 Subject: [PATCH 1/2] spelling errors --- portal/cookbook-guide.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/portal/cookbook-guide.md b/portal/cookbook-guide.md index 713cd3fd..5fcc1272 100644 --- a/portal/cookbook-guide.md +++ b/portal/cookbook-guide.md @@ -47,15 +47,15 @@ In the rest of this guide, we assume that you are familiar with the basics of us In order for your Cookbook to be included in the Gallery, the source repository needs to be housed within the [Project Pythia GitHub organization](https://github.com/ProjectPythia). -You can keep your repository in your personal GitHub space while you're developing your content if that works better for you. Repository ownership can be transfered at any time. +You can keep your repository in your personal GitHub space while you're developing your content if that works better for you. Repository ownership can be transferred at any time. -However, we recommend transfering to the Pythia organization early, for a few reasons: +However, we recommend transferring to the Pythia organization early, for a few reasons: - Fewer settings to tweak later - Easier to get help from the Pythia infrastructure team - Encourages collaboration ```{Note} -You're still in control! You will always retain write access to your Cookbook repository even after transfering ownership to the Pythia organization. +You're still in control! You will always retain write access to your Cookbook repository even after transferring ownership to the Pythia organization. Also, _don't worry about breaking anything!_ Your repo will not affect any other Project Pythia content until you initiate the request to list it on the [Cookbook Gallery](https://cookbooks.projectpythia.org) (see below...) ``` @@ -63,14 +63,14 @@ Also, _don't worry about breaking anything!_ Your repo will not affect any other ### Steps to transfer the repository 1. [Contact the Pythia team via the Pangeo Discourse](https://discourse.pangeo.io/c/education/project-pythia/60) (or otherwise) to let us know about your cookbook. -1. You will get an invitation to join the the [ProjectPythia organization](https://github.com/ProjectPythia). +1. You will get an invitation to join the [ProjectPythia organization](https://github.com/ProjectPythia). 1. Accept the GitHub invitation. _Welcome to the team!_ 1. Once you are a member of the organization, navigate to the Settings of your cookbook repository and scroll down to the **Danger Zone**. 1. Click "Transfer". 1. Select or type "ProjectPythia", confirm, and transfer. 1. When prompted about which teams to give access to, select "core". _This will enable the Pythia maintenance team to have full access to your repository._ -Once you have successfully transfered the repository, you'll most likely want to make a [personal fork and a local clone of the repository](https://foundations.projectpythia.org/foundations/github/github-cloning-forking.html) so that you can continue to develop and collaborate on the Cookbook via the [forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows.html#forking-workflow). +Once you have successfully transferred the repository, you'll most likely want to make a [personal fork and a local clone of the repository](https://foundations.projectpythia.org/foundations/github/github-cloning-forking.html) so that you can continue to develop and collaborate on the Cookbook via the [forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows.html#forking-workflow). ## Customize the paths in your repository @@ -168,9 +168,9 @@ Here's a handy trick for finding your published book: The link to your published book will then be displayed on the home page of the repo. ```{Note} -If you have transfered your repository to the ProjectPythia organization and also made a personal fork, the publishing pipeline automation will _only run on the upstream fork on the ProjectPythia organization_ so there's only one copy of the "published" book. +If you have transferred your repository to the ProjectPythia organization and also made a personal fork, the publishing pipeline automation will _only run on the upstream fork on the ProjectPythia organization_ so there's only one copy of the "published" book. -It's possible to enable the workflows on your personal fork, but usually unneccesary if you preview your work via Pull Requests (see next section)! +It's possible to enable the workflows on your personal fork, but usually unnecesary if you preview your work via Pull Requests (see next section)! ``` ### Pull Requests and previews @@ -188,7 +188,7 @@ Not satisfied? Keep making changes! Every new push to the feature branch on your ### Building on the Pythia Binder ```{Note} -By default, notebooks are executed on the free GitHub Actions service. This works fine for most lightweight Cookbooks. If your book is building and publishing succesfully, you can safely ignore this section! +By default, notebooks are executed on the free GitHub Actions service. This works fine for most lightweight Cookbooks. If your book is building and publishing successfully, you can safely ignore this section! ``` For Cookbooks with substantial compute requirements, you have the option of routing notebook execution to a specialized Binder service maintained by the Project Pythia team. @@ -206,10 +206,10 @@ The Binder uses your `environment.yml` file to create an image of an execution e ## Publish your Cookbook on the Pythia Gallery -Once you're happy with your content and your Cookbook is building and deploying properly, it's time to think about submiting it for inclusion in the [Cookbook Gallery](https://cookbooks.projectpythia.org/)! +Once you're happy with your content and your Cookbook is building and deploying properly, it's time to think about submitting it for inclusion in the [Cookbook Gallery](https://cookbooks.projectpythia.org/)! ```{Note} -Cookbooks don't need to be "finished" in order to accepted in the Gallery! Cookbooks are typically accepted so long as they run cleanly, are free of obvious errors, and have some relevant new content. +Cookbooks don't need to be "finished" in order to be accepted in the Gallery! Cookbooks are typically accepted so long as they run cleanly, are free of obvious errors, and have some relevant new content. Cookbooks are meant to be living documents. We encourage authors to open GitHub issues to track progress on adding and updating content. ``` @@ -218,7 +218,7 @@ At this stage, there are a few more steps to get things ready to go. ### Authorship and the `CITATION.cff` file -Cookbooks are scholarly objects. As part of the publication process, your Cookbook will get a citeable DOI (via [Zenodo](https://zenodo.org)). Just as for journal publications, you need to make decisions about who gets credited for authorship. +Cookbooks are scholarly objects. As part of the publication process, your Cookbook will get a citable DOI (via [Zenodo](https://zenodo.org)). Just as for journal publications, you need to make decisions about who gets credited for authorship. This information is managed manually through the file `CITATION.cff` in the root of your repository. This will determine the names displayed on your card in the [gallery](https://cookbooks.projectpythia.org/) as well as your DOI-based citation. From ca5cc5949af0f0ef9d9bc9063e1cee88093b0a55 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Fri, 18 Apr 2025 13:23:24 -0600 Subject: [PATCH 2/2] Update portal/cookbook-guide.md Co-authored-by: Orhan Eroglu <32553057+erogluorhan@users.noreply.github.com> --- portal/cookbook-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/portal/cookbook-guide.md b/portal/cookbook-guide.md index 5fcc1272..2eeedaad 100644 --- a/portal/cookbook-guide.md +++ b/portal/cookbook-guide.md @@ -170,7 +170,7 @@ The link to your published book will then be displayed on the home page of the r ```{Note} If you have transferred your repository to the ProjectPythia organization and also made a personal fork, the publishing pipeline automation will _only run on the upstream fork on the ProjectPythia organization_ so there's only one copy of the "published" book. -It's possible to enable the workflows on your personal fork, but usually unnecesary if you preview your work via Pull Requests (see next section)! +It's possible to enable the workflows on your personal fork, but usually unnecessary if you preview your work via Pull Requests (see next section)! ``` ### Pull Requests and previews