Skip to content

Commit e31a58c

Browse files
committed
Add lines between major sections
1 parent eb0d5db commit e31a58c

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

portal/cookbook-guide.md

+11
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ These instructions assume that your goal is to contribute a new Cookbook to the
1616
Using the Pythia Cookbook template to create reproducible documents housed elsewhere is definitely possible! But we don't focus on that use case in this guide.
1717
```
1818

19+
---
20+
1921
## Data access
2022

2123
Before developing your cookbook, you should consider how it will access the data you plan to use. In loose order of preference, we recommend the following:
@@ -25,6 +27,8 @@ Before developing your cookbook, you should consider how it will access the data
2527
1. Discuss your larger data storage needs with the Pythia team. We are currently experimenting with cloud object storage for Cookbooks via NSF JetStream2.
2628
1. Provide the tools and/or clear documentation for accessing the data that you have stored somewhere else
2729

30+
---
31+
2832
## Use the template
2933

3034
1. If you don't already have a GitHub account, create one by following the [Getting Started with GitHub guide](https://foundations.projectpythia.org/foundations/getting-started-github.html)
@@ -40,6 +44,8 @@ Your cookbook is now ready to have content added!
4044
In the rest of this guide, we assume that you are familiar with the basics of using git and GitHub. If not, we strongly recommend reading through our [GitHub tutorials in Foundations](https://foundations.projectpythia.org/foundations/getting-started-github.html).
4145
```
4246

47+
---
48+
4349
## Transfer your cookbook repo to the ProjectPythia organization
4450

4551
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).
@@ -68,13 +74,15 @@ Also, _don't worry about breaking anything!_ Your repo will not affect any other
6874

6975
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).
7076

77+
---
7178

7279
## Customize the paths in your repository
7380

7481
Whether the repository lives in your personal GitHub space or on the ProjectPythia organization, there are several paths and links in the repository code that need to be updated to reflect the current home of your cookbook source. This step is necessary to ensure that the cookbook building and publishing infrastructure works as intended.
7582

7683
Fortunately this is quick and easy. Just run our custom GitHub action called `trigger-replace-links`: Navigate to "Actions" → "trigger-replace-links" → "Run workflow".
7784

85+
---
7886

7987
## Set up the computational environment
8088

@@ -101,6 +109,7 @@ In each of these files, in the field called `environment_name:`, replace `cookb
101109
If these workflow files look mysterious and you don't know anything about how GitHub Actions work, don't worry! The Pythia team will help with any problems that arise with the Cookbook automation.
102110
```
103111

112+
---
104113

105114
## Develop your cookbook
106115

@@ -139,6 +148,7 @@ To strip a notebook, in a Jupyter Lab session, go to "Kernel" → "Restart Ke
139148

140149
You're ready to push content up to GitHub and trigger the automated publishing pipeline.
141150

151+
---
142152

143153
## Deploying your Cookbook
144154

@@ -196,6 +206,7 @@ Here's how:
196206
The Binder uses your `environment.yml` file to create an image of an execution environment, which is stored for reuse. The time to execute your notebooks can vary, depending on whether the Binder needs to build a new image or not.
197207
```
198208

209+
---
199210

200211
## Publish your Cookbook on the Pythia Gallery
201212

0 commit comments

Comments
 (0)