You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: portal/cookbook-guide.md
+11-11
Original file line number
Diff line number
Diff line change
@@ -47,30 +47,30 @@ In the rest of this guide, we assume that you are familiar with the basics of us
47
47
48
48
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).
49
49
50
-
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.
50
+
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.
51
51
52
-
However, we recommend transfering to the Pythia organization early, for a few reasons:
52
+
However, we recommend transferring to the Pythia organization early, for a few reasons:
53
53
- Fewer settings to tweak later
54
54
- Easier to get help from the Pythia infrastructure team
55
55
- Encourages collaboration
56
56
57
57
```{Note}
58
-
You're still in control! You will always retain write access to your Cookbook repository even after transfering ownership to the Pythia organization.
58
+
You're still in control! You will always retain write access to your Cookbook repository even after transferring ownership to the Pythia organization.
59
59
60
60
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...)
61
61
```
62
62
63
63
### Steps to transfer the repository
64
64
65
65
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.
66
-
1. You will get an invitation to join the the [ProjectPythia organization](https://github.com/ProjectPythia).
66
+
1. You will get an invitation to join the [ProjectPythia organization](https://github.com/ProjectPythia).
67
67
1. Accept the GitHub invitation. _Welcome to the team!_
68
68
1. Once you are a member of the organization, navigate to the Settings of your cookbook repository and scroll down to the **Danger Zone**.
69
69
1. Click "Transfer".
70
70
1. Select or type "ProjectPythia", confirm, and transfer.
71
71
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._
72
72
73
-
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).
73
+
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).
74
74
75
75
## Customize the paths in your repository
76
76
@@ -168,9 +168,9 @@ Here's a handy trick for finding your published book:
168
168
The link to your published book will then be displayed on the home page of the repo.
169
169
170
170
```{Note}
171
-
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.
171
+
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.
172
172
173
-
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)!
173
+
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)!
174
174
```
175
175
176
176
### Pull Requests and previews
@@ -188,7 +188,7 @@ Not satisfied? Keep making changes! Every new push to the feature branch on your
188
188
### Building on the Pythia Binder
189
189
190
190
```{Note}
191
-
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!
191
+
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!
192
192
```
193
193
194
194
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
206
206
207
207
## Publish your Cookbook on the Pythia Gallery
208
208
209
-
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/)!
209
+
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/)!
210
210
211
211
```{Note}
212
-
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.
212
+
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.
213
213
214
214
Cookbooks are meant to be living documents. We encourage authors to open GitHub issues to track progress on adding and updating content.
215
215
```
@@ -218,7 +218,7 @@ At this stage, there are a few more steps to get things ready to go.
218
218
219
219
### Authorship and the `CITATION.cff` file
220
220
221
-
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.
221
+
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.
222
222
223
223
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.
0 commit comments