Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,29 +51,29 @@ This section will help one to setup the project for local development.
### Requirements

- Node version >= 12.13.0
- yarn
- npm

This project has been built using [Docusaurus 2](https://docusaurus.io/), which requires Node version >=12.13.0, you can check this using `node -v`. [Install node](https://nodejs.org/en/download/).
Make sure yarn is installed. [Install yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable).
Make sure npm is installed. npm is included with Node.js.

### Installation

```console
yarn install
npm ci
```

### Local Development

```console
yarn start
npm start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```console
yarn build
npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
Expand All @@ -89,7 +89,7 @@ All involved are expected to follow the [PEcAn code of conduct](https://pecanpro

First time contributors are welcome. Contributions can be very simple, make sure to check out issues labeled ['good first issue'](https://github.com/PecanProject/PecanProject.github.io/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22). If you have an idea, the best place to start a discussion is on the PEcAn project Slack channel, or by opening an issue in this repository.

Changes to `package-lock.json` and `yarn.lock` files should only be committed when:
Changes to `package-lock.json` should only be committed when:

- Adding a new dependency: Installing a new package will modify these lock files to ensure the exact version is documented.
- Updating an existing dependency: Running an update for a package will adjust these files to reflect the new versions.
Expand Down Expand Up @@ -179,7 +179,7 @@ Steps to add a blog post:
- If the author is not already listed in `blog/authors.yml` add them as a new entry.
4. write your blog and save the file.
5. any images can be put in `static/img/` and referenced using a relative path `static/img/myimage.png`
6. build the website to make sure the blog shows up as expected (`yarn build` and `yarn start`
6. build the website to make sure the blog shows up as expected (`npm run build` and `npm start`)
7. After the new changes are merged into the main branch, the new blog post will appear on the website.

Here is an example of the blog header:
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/develop.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function Develop() {
// sandbox=""
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/develop/">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/latest.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function Latest() {
// sandbox=""
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/latest/">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/v1_10_0.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function V1_10_0() {
id="iFrame3"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/v1.10.0">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/v1_8_0.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function V1_8_0() {
id="iFrame3"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/v1.8.0">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/v1_9_0.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function V1_9_0() {
id="iFrame3"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/v1.9.0">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/version14101.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function Versioin14101() {
id="iFrame9"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/1.4.10.1/">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/version150.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function Versioin150() {
id="iFrame8"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/1.5.0">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/version151.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function Versioin151() {
id="iFrame7"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/v1.5.1">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/version153.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function Versioin153() {
id="iFrame6"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/v1.5.3">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/version160.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function Versioin160() {
id="iFrame5"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/v1.6.0">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/version170.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function Versioin170() {
id="iFrame4"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/1.7.0">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/documentation/version171.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function Versioin171() {
id="iFrame3"
>
<p>
<a href="/en-US/docs/Glossary">
<a href="https://pecanproject.github.io/pecan-documentation/v1.7.1">
Fallback link for browsers that don't support iframes
</a>
</p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/documentation/latest"
to="/documentation/latest/"
>
Get Started
</Link>
Expand Down
Loading