Skip to content

Commit 935b6ed

Browse files
jukentkafitzgerald
andauthored
Quick broken internal link fix (#572)
* Update cookbook-guide.md * Apply suggestion from @kafitzgerald Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Apply suggestion from @kafitzgerald Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> --------- Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com>
1 parent db9b245 commit 935b6ed

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

portal/cookbook-guide.md

Lines changed: 3 additions & 3 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#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/git-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

@@ -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) 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).
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/git-workflows/#forking-workflow).
192192

193193

194194
## G. Deploying your Cookbook
@@ -230,7 +230,7 @@ Collaboration on Cookbooks is best done via [Pull Requests](https://foundations.
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#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/git-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

0 commit comments

Comments
 (0)