Skip to content

Commit 005a72d

Browse files
authored
remove .html from links (#548)
1 parent 47d3766 commit 005a72d

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing to the Project Pythia Portal
22

33
This document contains information specific to contributing to the
4-
Project Pythia Portal. Please first refer to [Guide for Contributing to Project Pythia](https://projectpythia.org/contributing.html) for overall
4+
Project Pythia Portal. Please first refer to [Guide for Contributing to Project Pythia](https://projectpythia.org/contributing) for overall
55
contribution guidelines (such as detailed description of Project
66
Pythia structure, forking, repository cloning, branching, etc.).
77

portal/contributing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
This the top-level guide for Project Pythia and a great starting point for getting involved!
55
66
We also have specific guides for
7-
[contributing to Pythia Foundations](https://foundations.projectpythia.org/appendix/how-to-contribute.html)
8-
and [contributing new Cookbooks](https://projectpythia.org/cookbook-guide.html).
7+
[contributing to Pythia Foundations](https://foundations.projectpythia.org/appendix/how-to-contribute)
8+
and [contributing new Cookbooks](https://projectpythia.org/cookbook-guide).
99
```
1010

1111
## Overview
1212

1313
Welcome! This is the main guide for contributing to Project Pythia.
1414
Project Pythia is an open community, and all contributions are
1515
welcome following our [Code of
16-
Conduct](https://projectpythia.org/code_of_conduct.html). All
16+
Conduct](https://projectpythia.org/code_of_conduct). All
1717
of the content for Project Pythia is hosted on GitHub in a number
1818
of different public repositories. From this document you can learn
1919
about the many ways that you can contribute to this community
@@ -37,7 +37,7 @@ forum](https://discourse.pangeo.io/c/education/project-pythia/).
3737
### Add content to the Resource Gallery
3838

3939
The Project [Pythia Resource
40-
Gallery](https://projectpythia.org/resource-gallery.html) contains a
40+
Gallery](https://projectpythia.org/resource-gallery) contains a
4141
collection of links to useful resources that were created and are
4242
hosted outside of Project Pythia. Some examples include: documentation
4343
and tutorials for iconic packages such as Matplotlib, Cartopy, and
@@ -233,7 +233,7 @@ example, and clicking on the file named `CONTRIBUTING.md`
233233
```
234234

235235
More information on installing and using conda may be found
236-
[here](https://foundations.projectpythia.org/foundations/conda.html).
236+
[here](https://foundations.projectpythia.org/foundations/conda).
237237

238238
### Forking a repo
239239

portal/cookbook-guide.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ These instructions assume that your goal is to contribute a new Cookbook to the
2222
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.
2323
```
2424

25-
If you're not looking to create a _new_ Cookbook, but rather looking for guidance on contributing to _existing_ Cookbooks, first make sure you're comfortable with the [GitHub forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows.html#forking-workflow), then take a look at the section below on "Pull Requests and previews".
25+
If you're not looking to create a _new_ Cookbook, but rather looking for guidance on contributing to _existing_ Cookbooks, first make sure you're comfortable with the [GitHub forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows#forking-workflow), then take a look at the section below on "Pull Requests and previews".
2626

2727
## A. Data access and storage considerations for Cookbooks
2828

@@ -50,7 +50,7 @@ For many concepts, we encourage writing self-contained functions to generate sim
5050

5151
## B. Create a Repository From the Cookbook Template
5252

53-
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).
53+
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).
5454
1. On the [Cookbook Template repository](https://github.com/ProjectPythia/cookbook-template), click "Use this template → Create a new repository".
5555
1. Choose "Include all branches".
5656
1. Give your repository a descriptive name followed by `-cookbook` (e.g., `hydrology-cookbook`, `hpc-cookbook`, `cesm-cookbook`) and a description.
@@ -61,20 +61,20 @@ For many concepts, we encourage writing self-contained functions to generate sim
6161
<img width="901" alt="Screenshot 2023-01-13 at 3 12 47 PM" src="https://user-images.githubusercontent.com/26660300/212428991-cd0ae2f0-73ca-40d8-b983-f122359463aa.png">
6262

6363
```{note}
64-
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).
64+
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.
6565
```
6666

6767
Your cookbook is now ready to have content added!
6868

6969

7070
## C. Set up the Computational Environment
7171

72-
You'll most likely want to do your edits in a [local clone of the repository](https://foundations.projectpythia.org/foundations/github/github-cloning-forking.html) on your laptop or wherever your are running your notebooks.
72+
You'll most likely want to do your edits in a [local clone of the repository](https://foundations.projectpythia.org/foundations/github/github-cloning-forking) on your laptop or wherever your are running your notebooks.
7373

7474
### Customizing Your Conda Environment
7575

7676
1. Within `environment.yml` (in the root of the repository), change `name` from `cookbook-dev` to `<your-cookbook-name>-dev` (e.g. `cesm-cookbook-dev`) and add all required libraries and other dependencies under `dependencies:`. Commit the changes.
77-
1. Create the [conda environment](https://foundations.projectpythia.org/foundations/conda.html) with `conda env create -f environment.yml`. If it crashes, try running `conda config --set channel_priority strict`
77+
1. Create the [conda environment](https://foundations.projectpythia.org/foundations/conda) with `conda env create -f environment.yml`. If it crashes, try running `conda config --set channel_priority strict`
7878
1. Activate your environment with `conda activate <env-name>`
7979

8080
You're now ready to create and run awesome notebooks.
@@ -188,7 +188,7 @@ Also, _don't worry about breaking anything!_ Your repo will not affect any other
188188
1. Select or type "ProjectPythia", confirm, and transfer.
189189
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._
190190

191-
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).
191+
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) so that you can continue to develop and collaborate on the Cookbook via the [forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows#forking-workflow).
192192

193193

194194
## G. Deploying your Cookbook
@@ -226,11 +226,11 @@ It's possible to enable the workflows on your personal fork, but usually unneces
226226

227227
### Pull Requests and previews
228228

229-
Collaboration on Cookbooks is best done via [Pull Requests](https://foundations.projectpythia.org/foundations/github/github-pull-request.html). Every PR on a Cookbook repository will trigger a "Preview" version of our publishing pipeline. The entire book is re-built from the updated source and the preview site is hosted at a temporary online location. This way, the team can safely see what the end product will look like after the PR is merged.
229+
Collaboration on Cookbooks is best done via [Pull Requests](https://foundations.projectpythia.org/foundations/github/github-pull-request). Every PR on a Cookbook repository will trigger a "Preview" version of our publishing pipeline. The entire book is re-built from the updated source and the preview site is hosted at a temporary online location. This way, the team can safely see what the end product will look like after the PR is merged.
230230

231231
The only difference between the "preview" pipeline and the regular publishing pipeline is the URL to which the rendered website is deployed. A temporary preview location is used, leaving the main book untouched until the PR is merged.
232232

233-
To propose changes to a Cookbook, or even just to test something out temporarily, follow the [forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows.html#forking-workflow): make changes on a feature branch of your personal fork, and open a Pull Request from that branch to the main branch of the upstream fork. This will trigger the preview.
233+
To propose changes to a Cookbook, or even just to test something out temporarily, follow the [forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows#forking-workflow): make changes on a feature branch of your personal fork, and open a Pull Request from that branch to the main branch of the upstream fork. This will trigger the preview.
234234

235235
A link to the preview will appear as a comment on the Pull Request once the publishing actions are complete. _If the link shows up but you get a 404 error when you click on it the first time, just wait a few minutes! There are some lags before the preview is fully deployed._
236236

portal/cookbook-tasklist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Once we've marked this entire checklist, [click here to open an issue on Project
88

99
---
1010

11-
- [ ] **Confirm you’ve followed the entire Project Pythia [Cookbook Guide](https://projectpythia.org/cookbook-guide.html)**.
12-
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.**
11+
- [ ] **Confirm you’ve followed the entire Project Pythia [Cookbook Guide](https://projectpythia.org/cookbook-guide)**.
12+
Take note especially of the [Develop your cookbook](https://projectpythia.org/cookbook-guide/#d-develop-your-cookbook), [Authorship and the CITATION.cff file](https://projectpythia.org/cookbook-guide/#e-making-your-cookbook-findable-and-citable), and [Gallery tags](https://projectpythia.org/cookbook-guide/#id-2-tag-your-cookbook) sections. **Save the [Generate a DOI](https://projectpythia.org/cookbook-guide#generate-a-doi) step as the last step of this checklist.**
1313
- [ ] **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)**.
1414
If the template does not fit your Cookbook’s needs, that’s fine too! Simply let us know here in this issue.
1515
- [ ] **Finalize your Cookbook repository name.**
@@ -42,7 +42,7 @@ This can be seen in individual Pull Requests as green checkmarks ✅ for importa
4242
- [ ] **Identify a Maintainer team via GitHub handle(s) in this thread.**
4343
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.
4444
- [ ] **Link your Cookbook repo to Zenodo for DOI generation**
45-
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:
45+
Follow steps 1-4 under [Generate a DOI](https://projectpythia.org/cookbook-guide/#id-1-credit-yourself) in the Cookbook Guide. Return here for instructions on step 5, and your final step:
4646
- [ ] **Release your Cookbook!**
4747
- 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.
4848
![GitHub Repository sidebar section titled "Releases"](https://raw.githubusercontent.com/ProjectPythia/projectpythia.github.io/main/portal/_static/images/4-releases.png "Releases")

portal/posts/2025/new-cookbooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,4 +204,4 @@ This Cookbook covers how to work with wavelets in Python. Wavelets are a powerfu
204204

205205
Do you have some feedback or ideaa for a new Cookbook project? Unsure how to get started? We'd love to hear from you at any of our [open meetings](https://projectpythia.org/#monthly-pythia-meetings), through the [Pangeo Discourse](https://discourse.pangeo.io/c/education/project-pythia/), or via any of our social media. Join us at our next Cook-off 2025!
206206

207-
Take a look at our [guide for Cookbook contributors](https://projectpythia.org/cookbook-guide.html).
207+
Take a look at our [guide for Cookbook contributors](https://projectpythia.org/cookbook-guide).

portal/quick-cookbook-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This document is designed be lightweight. For more detailed, step-by-step instuc
2626

2727
## Update Content
2828

29-
Follow [Git/GitHub best practices](https://foundations.projectpythia.org/foundations/getting-started-github.html) with your collaborators:
29+
Follow [Git/GitHub best practices](https://foundations.projectpythia.org/foundations/getting-started-github) with your collaborators:
3030

3131
- Add content with your scientific insight as `.ipynb` files in the `notebooks/` folder
3232
- Update `environment.yml` to include all necessary packages

0 commit comments

Comments
 (0)