Skip to content

Commit bcc2bb2

Browse files
authored
update contributing guides (#536)
* update guides * active language * active language * zenodo admin
1 parent 22621bf commit bcc2bb2

File tree

5 files changed

+238
-167
lines changed

5 files changed

+238
-167
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# Pythia Portal contributor's guide
1+
# 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 [Pythia Contributor's
5-
Guide](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.html) for overall
65
contribution guidelines (such as detailed description of Project
76
Pythia structure, forking, repository cloning, branching, etc.).
87

@@ -22,7 +21,7 @@ The post will automatically be recognized and displayed when you build the porta
2221

2322
## Instructions for building the portal site
2423

25-
The portal site is built with [Sphinx](https://www.sphinx-doc.org/).
24+
The portal site is built with [MyST-MD](https://mystmd.org/).
2625

2726
When testing new content it is important to build and view the site. Read the Docs automatically builds the site for you when each Pull Request is checked. However, you can also build it locally on your machine following the instructions
2827
below.
@@ -70,28 +69,12 @@ _NOTE_: The `pre-commit` package is already installed via the `pythia` conda env
7069
Build the site locally using Sphinx (which you just installed in the `pythia` environment, along with all necessary dependencies):
7170

7271
```bash
73-
make html
72+
myst start --execute
7473
```
7574

76-
If this step fails and you have not updated your conda environment recently, try updating with `conda env update -f ../environment.yml` and `conda update --all` as described above.
75+
If this step fails and you may not have updated your conda environment recently, try updating with `conda env update -f ../environment.yml` and `conda update --all` as described above.
7776

78-
The newly rendered site is now available in `portal/_build/html/index.html`.
79-
Open with your web browser, or from the terminal:
80-
81-
```bash
82-
open _build/html/index.html
83-
`````
84-
85-
However, many of the links will not work. For all of the links
86-
found in the portal to work properly, you'll need to set up a local
87-
testing server. This can be done with Python's http.server by running
88-
the following command from within the `portal` directory:
89-
90-
```bash
91-
python -m http.server --directory _build/html/
92-
```
93-
94-
and then pointing your browser at the URL: localhost:8000.
77+
The newly rendered site is now available at [localhost:3000](http://localhost:3000). A link should appear in your terminal.
9578

9679
More information on setting up a local test server is available from [here](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/set_up_a_local_testing_server)
9780

@@ -108,15 +91,6 @@ conda activate pythia
10891
conda update --all
10992
```
11093

111-
### Preview the built site on Netlify
112-
113-
Once a pull request has passed all tests, including the `preview-site` check, the GitHub bot will post a comment with a preview link on the pull request. You can click on the link to launch a new tab with a build of the Project Pythia site.
114-
115-
![CI-check](/portal/_static/images/deploy-site-CI-check.png)
116-
117-
![Netlify Preview](/portal/_static/images/netlify-preview.png)
118-
119-
12094
## Instructions for intacting with the Google Analytics API
12195

12296
### Setting up the Virtual Environment

myst.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# See docs at: https://mystmd.org/guide/frontmatter
2+
version: 1
3+
extends:
4+
- https://raw.githubusercontent.com/projectpythia/pythia-config/main/pythia.yml
5+
project:
6+
id: 770e49e5-344a-4c46-adaa-3afb060b2085
7+
# title:
8+
# description:
9+
keywords: []
10+
authors: []
11+
github: https://github.com/projectpythia/projectpythia.github.io
12+
# bibliography: []
13+
14+
toc:
15+
- file: portal/index.md
16+
- file: portal/about.md
17+
- title: Blog
18+
children:
19+
- pattern: portal/posts/*.md
20+
- file: portal/contributing.md
21+
- file: portal/cookbook-guide.md
22+
- file: portal/quick-cookbook-guide.md
23+
- file: portal/metrics.md
24+
site:
25+
actions:
26+
- title: Learn More
27+
url: https://mystmd.org/guide
28+
domains: []
29+
options:
30+
style: style.css

portal/contributing.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Project Pythia Contributor's Guide
1+
# Contributing to Project Pythia
22

33
```{note}
44
This the top-level guide for Project Pythia and a great starting point for getting involved!
@@ -10,16 +10,15 @@ and [contributing new Cookbooks](https://projectpythia.org/cookbook-guide.html).
1010

1111
## Overview
1212

13-
Welcome! This is the main contributors guide for Project Pythia.
13+
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
1616
Conduct](https://projectpythia.org/code_of_conduct.html). 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
2020
project, and where you can find additional information. In many
21-
cases pertinent details may be found in repository-specific
22-
contributors guides **that should always be consulted in addition
21+
cases pertinent details may be found in repository-specific guides **that should always be consulted in addition
2322
to this guide**. More on this topic later.
2423

2524
## The many ways to contribute
@@ -72,7 +71,7 @@ is a collection of material that the Pythia team believes is essential
7271
knowledge for geoscientists to effectively use the Scientific Python
7372
Ecosystem. The Pythia Foundations content is hosted on a separate
7473
[GitHub repo](https://github.com/ProjectPythia/pythia-foundations),
75-
and contributors should consult the contributor’s guide there for
74+
and contributors should consult the [Contributing to Foundations](https://foundations.projectpythia.org/appendix/how-to-contribute) guide there for
7675
information specific to Foundations. However, adding new, or changing
7776
existing Foundations content requires contributors to be familiar
7877
with a few technologies and workflows, described in Advanced
@@ -88,7 +87,7 @@ specific problem. Typically, a cookbook references material presented
8887
elsewhere in Project Pythia, such as [Pythia Foundations](https://foundations.projectpythia.org).
8988
Each Cookbook is hosted in a separate GitHub repo under the umbrella [Project Pythia
9089
organization](https://github.com/ProjectPythia).
91-
Contributors should consult the [Cookbook-specific Contributor's guide](/cookbook-guide).
90+
Contributors should consult the [Contributing a New Cookbook](/cookbook-guide) guide.
9291

9392
### Pythia Portal
9493

@@ -114,10 +113,10 @@ process of setting up GitHub/Git, installing and configuring conda,
114113
and submitting a PR. Note, while this information is common to all
115114
Pythia repositories, repo-specific information might be required.
116115

117-
In all cases contributors should consult the repo-specific contributor’s
116+
In all cases contributors should consult the repo-specific contribution
118117
guide for their target repository.
119118

120-
Repo-specific guides can be found in the file named `CONTRIBUTING.md`, located in the top level directory of each repository, or by clicking on the menu item labeled “Contributor’s Guide” found in the rendered content generated by each repository.
119+
Repo-specific guides can be found in the file named `CONTRIBUTING.md`, located in the top level directory of most repositories, or by clicking on the appropriately named menu item on each site. Note that the "Contributing a new Cookbook" guide is found in the Pythia portal (rather than in any one specific Cookbook).
121120

122121
Lastly, much of this information has been co-opted from the [GeoCAT project](https://geocat.ucar.edu).
123122

@@ -221,12 +220,12 @@ desktop or laptop. Before using your conda environment to work on
221220
Pythia content, you'll need to perform an addtional one-time setup
222221
that is specific to each Pythia repo. After the one-time configuration is
223222
complete you will need to "activate" a repo-specific environment whenever
224-
you wish to use it. Consult the repo-specific contributor’s guide
223+
you wish to use it. Consult the repo-specific contribution guide
225224
for information on “Building the site”, and
226225
follow the steps described therein.
227226

228227
```{note}
229-
Repository-specific contributor's
228+
Repository-specific contribution
230229
information can always be accessed by navigating your web browser
231230
to the appropriate Project Pythia GitHub repository,
232231
[here](https://github.com/ProjectPythia/pythia-foundations) for
@@ -337,7 +336,7 @@ back to the Pythia repository you will need to submit a Pull Request
337336
### Make your local changes
338337

339338
At this point you should be able to make your desired changes to
340-
the local copies of your files. **Always consult the repo-specific contributor’s
339+
the local copies of your files. **Always consult the repo-specific contribution
341340
guide for information specific to the repo you are working on.**
342341

343342
### Submit a Pull Request (PR)

0 commit comments

Comments
 (0)