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
+17-17
Original file line number
Diff line number
Diff line change
@@ -33,18 +33,18 @@ Your cookbook is now ready to have content added. In the rest of this guide, we
33
33
34
34
## Update repository-specific text
35
35
36
-
-[ ] Automatically adjust link paths that need to be changed from the `cookbook-template` to your new cookbook by manually trigger the action “trigger-replace-links” GitHub action. Do this by navigating to "Actions" -> "trigger-replace-links" -> "Run workflow".
37
-
-[ ] Edit `_config.yml`. These will show up on your [card in the gallery](https://cookbooks.projectpythia.org/) and are used for filtering.
38
-
-[ ]title
39
-
-[ ]thumbnail (not logo). You may simply replace the default `thumbnail.png` with your own image
40
-
-[ ]tags
41
-
-[ ] Edit the `CITATION.cff` file Change the following fields. These will show up on your [card in the gallery](https://cookbooks.projectpythia.org/) and on your Zenodo citation.
42
-
-[ ]title
43
-
-[ ]authors
44
-
-[ ]authors' ORCID IDs and affiliation websites (optional)
45
-
-[ ]description/abstract
46
-
-[ ]Cookbook contributor name
47
-
-[ ] Edit the `notebooks/how-to-cite.md` file with your Cookbook title in the line, "The material in <ThisCookbook> is licensed ..."
36
+
1. Automatically adjust link paths that need to be changed from the `cookbook-template` to your new cookbook by manually trigger the action “trigger-replace-links” GitHub action. Do this by navigating to "Actions" -> "trigger-replace-links" -> "Run workflow".
37
+
1. Edit `_config.yml`. These will show up on your [card in the gallery](https://cookbooks.projectpythia.org/) and are used for filtering.
38
+
- title
39
+
- thumbnail (not logo). You may simply replace the default `thumbnail.png` with your own image
40
+
- tags
41
+
1. Edit the `CITATION.cff` file Change the following fields. These will show up on your [card in the gallery](https://cookbooks.projectpythia.org/) and on your Zenodo citation.
42
+
- title
43
+
- authors
44
+
- authors' ORCID IDs and affiliation websites (optional)
45
+
- description/abstract
46
+
- Cookbook contributor name
47
+
1. Edit the `notebooks/how-to-cite.md` file with your Cookbook title in the line, "The material in <ThisCookbook> is licensed ..."
48
48
49
49
## Set up the environment
50
50
@@ -60,11 +60,11 @@ Your cookbook is now ready to have content added. In the rest of this guide, we
60
60
To add content, you should edit (and duplicate as necessary) the notebook template `notebooks/notebook-template.ipynb`. You can add folders to organize notebooks into sections if applicable.
61
61
Once you have a set of notebooks that you are ready to share, there are various edits that need to be made so that your cookbook is functional and polished. Here is a checklist to go through before moving on to the next step:
62
62
63
-
-[ ]Add the notebooks to `_toc.yml` (the table of contents). See [`radar-cookbook/_toc.yml`](https://github.com/ProjectPythia/radar-cookbook/blob/main/_toc.yml) for syntax
64
-
-[ ]Edit `README.md` as described in that file. This is the homepage of your cookbook, so it should be descriptive
65
-
-[ ]If your cookbook requires more computing resources than available through GitHub Actions, change `execute_notebooks` from `cache` to `binder` in `_config.yml` to run your cookbook on the Pythia Binder
66
-
-[ ]Clear all notebook outputs, since the Pythia infrastructure will execute the notebooks
67
-
-[ ]Ensure that your cookbook successfully builds and shows the executed code
63
+
- Add the notebooks to `_toc.yml` (the table of contents). See [`radar-cookbook/_toc.yml`](https://github.com/ProjectPythia/radar-cookbook/blob/main/_toc.yml) for syntax
64
+
- Edit `README.md` as described in that file. This is the homepage of your cookbook, so it should be descriptive
65
+
- If your cookbook requires more computing resources than available through GitHub Actions, change `execute_notebooks` from `cache` to `binder` in `_config.yml` to run your cookbook on the Pythia Binder
66
+
- Clear all notebook outputs, since the Pythia infrastructure will execute the notebooks
67
+
- Ensure that your cookbook successfully builds and shows the executed code
68
68
69
69
## Transfer cookbook to the [ProjectPythia](https://github.com/ProjectPythia) organization
0 commit comments