Skip to content

Commit 82c1c6f

Browse files
committed
update guides
1 parent 22621bf commit 82c1c6f

File tree

5 files changed

+225
-152
lines changed

5 files changed

+225
-152
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

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

2323
## Instructions for building the portal site
2424

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

2727
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
2828
below.
@@ -70,28 +70,12 @@ _NOTE_: The `pre-commit` package is already installed via the `pythia` conda env
7070
Build the site locally using Sphinx (which you just installed in the `pythia` environment, along with all necessary dependencies):
7171

7272
```bash
73-
make html
73+
myst start --execute
7474
```
7575

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.
76+
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.
7777

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.
78+
The newly rendered site is now available at [localhost:3000](http://localhost:3000). A link should appear in your terminal.
9579

9680
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)
9781

@@ -108,15 +92,6 @@ conda activate pythia
10892
conda update --all
10993
```
11094

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-
12095
## Instructions for intacting with the Google Analytics API
12196

12297
### 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/pythia-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

0 commit comments

Comments
 (0)