You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -22,7 +21,7 @@ The post will automatically be recognized and displayed when you build the porta
22
21
23
22
## Instructions for building the portal site
24
23
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/).
26
25
27
26
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
28
27
below.
@@ -70,28 +69,12 @@ _NOTE_: The `pre-commit` package is already installed via the `pythia` conda env
70
69
Build the site locally using Sphinx (which you just installed in the `pythia` environment, along with all necessary dependencies):
71
70
72
71
```bash
73
-
make html
72
+
myst start --execute
74
73
```
75
74
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.
77
76
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.
95
78
96
79
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)
97
80
@@ -108,15 +91,6 @@ conda activate pythia
108
91
conda update --all
109
92
```
110
93
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.
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
76
75
information specific to Foundations. However, adding new, or changing
77
76
existing Foundations content requires contributors to be familiar
78
77
with a few technologies and workflows, described in Advanced
@@ -88,7 +87,7 @@ specific problem. Typically, a cookbook references material presented
88
87
elsewhere in Project Pythia, such as [Pythia Foundations](https://foundations.projectpythia.org).
89
88
Each Cookbook is hosted in a separate GitHub repo under the umbrella [Project Pythia
90
89
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.
92
91
93
92
### Pythia Portal
94
93
@@ -114,10 +113,10 @@ process of setting up GitHub/Git, installing and configuring conda,
114
113
and submitting a PR. Note, while this information is common to all
115
114
Pythia repositories, repo-specific information might be required.
116
115
117
-
In all cases contributors should consult the repo-specific contributor’s
116
+
In all cases contributors should consult the repo-specific contribution
118
117
guide for their target repository.
119
118
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).
121
120
122
121
Lastly, much of this information has been co-opted from the [GeoCAT project](https://geocat.ucar.edu).
123
122
@@ -221,12 +220,12 @@ desktop or laptop. Before using your conda environment to work on
221
220
Pythia content, you'll need to perform an addtional one-time setup
222
221
that is specific to each Pythia repo. After the one-time configuration is
223
222
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
225
224
for information on “Building the site”, and
226
225
follow the steps described therein.
227
226
228
227
```{note}
229
-
Repository-specific contributor's
228
+
Repository-specific contribution
230
229
information can always be accessed by navigating your web browser
231
230
to the appropriate Project Pythia GitHub repository,
232
231
[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
337
336
### Make your local changes
338
337
339
338
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
341
340
guide for information specific to the repo you are working on.**
0 commit comments