forked from ProjectPythia/projectpythia.github.io
-
Notifications
You must be signed in to change notification settings - Fork 1
Made a quicker cookbook guide. Referenced back the original guide. #18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Christian-Kofi-Okyere
wants to merge
2
commits into
projectpythia-mystmd:main
Choose a base branch
from
Christian-Kofi-Okyere:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# MyST Cookbook Contributing Guide Notes | ||
|
||
For a more detailed, step-by-step contributor guide, see the **Full Cookbook Contributor's Guide** | ||
<p style="text-align: center; margin-top: 2em;"> | ||
<a href="cookbook-guide.md" style="display: inline-block; background-color:rgb(13, 83, 130); color: white; padding: 8px 10px; font-size: 1.1em; border-radius: 8px;"> | ||
Full Cookbook Contributor's Guide → | ||
</a> | ||
</p> | ||
|
||
|
||
--- | ||
## Create Repository Using Template | ||
|
||
1. Navigate to [projectpythia-mystmd/cookbook-template](https://github.com/projectpythia-mystmd/cookbook-template) | ||
2. Click **"Use This Template"** → **"Create a new repository"** | ||
|
||
### On the next page: | ||
- Check **"Include all branches"** | ||
- You are the **owner** | ||
- Create your repository name (should end with `-cookbook`) | ||
- Select to keep it **Public** | ||
- Then click **"Create repository"** | ||
|
||
|
||
--- | ||
|
||
## Update Content | ||
|
||
Follow [Git/GitHub best practices](https://foundations.projectpythia.org/foundations/getting-started-github.html) with your collaborators: | ||
|
||
- Add content with your scientific insight as `.ipynb` files in the `notebooks/` folder | ||
- Update `environment.yml` to include all necessary packages | ||
- Update **thumbnail** to visually represent your work | ||
- Update `README.md` to reflect: | ||
- Title | ||
- Description | ||
- Motivation | ||
- Authors | ||
- Content structure | ||
|
||
- Update `myst.yml` with: | ||
- Title | ||
- GitHub link | ||
- Tags | ||
- Keywords (clarify the difference!) | ||
- Table of contents (`toc`) | ||
- Jupyter → Binder → Repo links | ||
|
||
- Update `CITATION.cff` with: | ||
- Authors’ names, ORCID, website, and affiliation | ||
- Title | ||
- Abstract | ||
|
||
--- | ||
|
||
## Ready to Publish? | ||
|
||
1. Make sure you’re added to the `projectpythia-mystmd` organization | ||
2. From **repository settings**, transfer the repo to the `projectpythia-mystmd` organization | ||
3. Open a PR editing `cookbook_gallery.txt` with your repo name in the [Cookbook Gallery Repository](https://github.com/projectpythia/cookbook-gallery) | ||
4. Await review | ||
5. Someone from the Pythia team will publish a **citable release** |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are probably other places in this guide that are no longer up to date.