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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ This describes how to add or modify the Website's content.
This is an open source project and contributions are what make an open source community.
Everyone is welcome to contribute to this project.

All involved are expected to follow the [PEcAn code of conduct](https://pecanproject.github.io/pecan-documentation/master/contributor-covenant-code-of-conduct.html) and contribute to a positive and inclusive environment.
All involved are expected to follow the [PEcAn code of conduct](https://pecanproject.github.io/pecan-documentation/develop/contributor-covenant-code-of-conduct.html) and contribute to a positive and inclusive environment.

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.

Expand Down Expand Up @@ -209,7 +209,7 @@ This section contains future plans for the website. New contributors can use thi

### Optimising Documentation

At present the PEcAn's documentation is being served from (<https://pecanproject.github.io/pecan-documentation/master/>) using an iframe. While this saves a lot of overhead in converting Rmd files in (<https://github.com/PecanProject/pecan/tree/develop/book_source>) to md files so that docusaurus could render them, it also increases the loading time for documentation, it also looks less consistent.
At present the PEcAn's documentation is being served from (<https://pecanproject.github.io/pecan-documentation/latest/>) using an iframe. While this saves a lot of overhead in converting Rmd files in (<https://github.com/PecanProject/pecan/tree/develop/book_source>) to md files so that docusaurus could render them, it also increases the loading time for documentation, it also looks less consistent.
In future, it is suggested to find an optimised way to convert rmd files to md and integrate them via docusaurus's native documentation parser.

### Adding tutorials section
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ module.exports = {
items: [
{
label: "Tutorial",
to: "/documentation/master",
to: "/documentation/latest",
className: "footer-docs-link",
},
],
Expand Down
54 changes: 51 additions & 3 deletions src/pages/documentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,23 @@ function Documentation() {
return (
<Layout title="documentation">
<div className={styles.aboutContainer}>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-30 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Latest Code Documentation</h3>

</div>
<div class="card__body">
<p>
<a href="documentation/develop" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest stable code (DEVELOP BRANCH).</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
Expand All @@ -16,7 +33,7 @@ function Documentation() {
</div>
<div class="card__body">
<p>
<a href="documentation/master" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest release (MASTER BRANCH).</u></a>
<a href="documentation/latest" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest release (MAIN BRANCH).</u></a>
</p>
</div>
</div>
Expand All @@ -28,12 +45,43 @@ function Documentation() {
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-30 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Latest Code Documentation</h3>
<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release 1.10.0</h3>
</div>
<div class="card__body">
<p>
<a href="documentation/v1_10_0" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.10.0.</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release 1.9.0</h3>
</div>
<div class="card__body">
<p>
<a href="documentation/develop" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest stable code (DEVELOP BRANCH).</u></a>
<a href="documentation/v1_9_0" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.9.0.</u></a>
</p>
</div>
</div>
</div>
</div>
<div className={clsx(styles.cardContainer)}>
{" "}
<div class={clsx("card-demo", styles.aboutCard)}>
<div class="card">
<div class="card__header" style={{ textAlign: "center" }}>

<h3 class="text-dark margin-bottom-30 margin-top-60 margin-m-top-30 text-size-20 text-m-size-16 text-line-height-1">Release 1.8.0</h3>
</div>
<div class="card__body">
<p>
<a href="documentation/v1_8_0" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.8.0.</u></a>
</p>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ import React from "react";
import Layout from "@theme/Layout";
import "./documentation.css";
import Foot from "@docusaurus/Head";
function Master() {
function Latest() {
return (
<>
<Layout title="Master" >
<Layout title="Latest" >
<Foot>
<body className="documentation"></body>
</Foot>
<iframe
src="https://pecanproject.github.io/pecan-documentation/master/"
src="https://pecanproject.github.io/pecan-documentation/latest/"
style={{ border: "none" }}
width="100%"
height="100%"
Expand All @@ -29,4 +29,4 @@ function Master() {
);
}

export default Master;
export default Latest;
30 changes: 30 additions & 0 deletions src/pages/documentation/v1_10_0.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import React from "react";
import Layout from "@theme/Layout";
import "./documentation.css";
import Foot from "@docusaurus/Head";
function V1_10_0() {
return (
<>
<Layout title="V1_10_0">
<Foot>
<body className="documentation"></body>
</Foot>
<iframe
src="https://pecanproject.github.io/pecan-documentation/v1.10.0"
style={{ border: "none" }}
width="100%"
height="100%"
id="iFrame3"
>
<p>
<a href="/en-US/docs/Glossary">
Fallback link for browsers that don't support iframes
</a>
</p>
</iframe>
</Layout>
</>
);
}

export default V1_10_0;
30 changes: 30 additions & 0 deletions src/pages/documentation/v1_8_0.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import React from "react";
import Layout from "@theme/Layout";
import "./documentation.css";
import Foot from "@docusaurus/Head";
function V1_8_0() {
return (
<>
<Layout title="V1_8_0">
<Foot>
<body className="documentation"></body>
</Foot>
<iframe
src="https://pecanproject.github.io/pecan-documentation/v1.8.0"
style={{ border: "none" }}
width="100%"
height="100%"
id="iFrame3"
>
<p>
<a href="/en-US/docs/Glossary">
Fallback link for browsers that don't support iframes
</a>
</p>
</iframe>
</Layout>
</>
);
}

export default V1_8_0;
30 changes: 30 additions & 0 deletions src/pages/documentation/v1_9_0.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import React from "react";
import Layout from "@theme/Layout";
import "./documentation.css";
import Foot from "@docusaurus/Head";
function V1_9_0() {
return (
<>
<Layout title="V1_9_0">
<Foot>
<body className="documentation"></body>
</Foot>
<iframe
src="https://pecanproject.github.io/pecan-documentation/v1.9.0"
style={{ border: "none" }}
width="100%"
height="100%"
id="iFrame3"
>
<p>
<a href="/en-US/docs/Glossary">
Fallback link for browsers that don't support iframes
</a>
</p>
</iframe>
</Layout>
</>
);
}

export default V1_9_0;
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/master"
to="/documentation/latest"
>
Get started
</Link>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/news.js
Original file line number Diff line number Diff line change
Expand Up @@ -1475,7 +1475,7 @@ function News() {
A few functions have already been added to the <a
href="https://github.com/ropensci/traits/">rOpensci traits
package</a> that can be found in the file <a
href="https://github.com/ropensci/traits/blob/master/R/betydb.R">R/betydb.R</a>.
href="https://github.com/ropensci/traits/blob/main/R/betydb.R">R/betydb.R</a>.
</p>
If you can help resolve open issues, implement new functionality, and
write vignettes please contact [email protected], submit a pull request
Expand Down
18 changes: 9 additions & 9 deletions src/pages/tutorials.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,25 +97,25 @@ function Tutorials() {

<h3 class="text-size-20 text-m-size-16 text-center">R Packages</h3>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/allometry/vignettes/AllomVignette.Rmd">Allometries</a></div>
<div><a href="https://github.com/PecanProject/pecan/blob/main/modules/allometry/vignettes/AllomVignette.Rmd">Allometries</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/assim.batch/vignettes/AssimBatchVignette.Rmd">MCMC </a> - in development</div>
<div><a href="https://github.com/PecanProject/pecan/blob/main/modules/assim.batch/vignettes/AssimBatchVignette.Rmd">MCMC </a> - in development</div>

<div><a href="https://github.com/PecanProject/pecan/tree/master/modules/data.atmosphere/vignettes">Meteorology Data</a></div>
<div><a href="https://github.com/PecanProject/pecan/tree/main/modules/data.atmosphere/vignettes">Meteorology Data</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/meta.analysis/vignettes/single.MA_demo.Rmd">Meta-Analysis</a></div>
<div><a href="https://github.com/PecanProject/pecan/blob/main/modules/meta.analysis/vignettes/single.MA_demo.Rmd">Meta-Analysis</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/photosynthesis/vignettes/ResponseCurves.Rmd">Photosynthetic response curves</a></div>
<div><a href="https://github.com/PecanProject/pecan/blob/main/modules/photosynthesis/vignettes/ResponseCurves.Rmd">Photosynthetic response curves</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/priors/vignettes/priors_demo.Rmd">Priors</a></div>
<div><a href="https://github.com/PecanProject/pecan/blob/main/modules/priors/vignettes/priors_demo.Rmd">Priors</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/modules/rtm/vignettes/pecanrtm.vignette.Rmd">Leaf spectra: PROSPECT inversion</a></div>
<div><a href="https://github.com/PecanProject/pecan/blob/main/modules/rtm/vignettes/pecanrtm.vignette.Rmd">Leaf spectra: PROSPECT inversion</a></div>

<h3>Concepts</h3>

<div><a href="https://github.com/PecanProject/pecan/tree/master/documentation/tutorials/sensitivity/PEcAn_sensitivity_tutorial_v1.0.Rmd">Model-Data Fusion: Univariate calibration 'by hand'</a></div>
<div><a href="https://github.com/PecanProject/pecan/tree/main/documentation/tutorials/sensitivity/PEcAn_sensitivity_tutorial_v1.0.Rmd">Model-Data Fusion: Univariate calibration 'by hand'</a></div>

<div><a href="https://github.com/PecanProject/pecan/blob/master/documentation/tutorials/MCMC/MCMC_Concepts.Rmd">Model-Data Fusion: MCMC</a></div>
<div><a href="https://github.com/PecanProject/pecan/blob/main/documentation/tutorials/MCMC/MCMC_Concepts.Rmd">Model-Data Fusion: MCMC</a></div>

<h1>
<a name="pecans-approach" class="anchor" href="#pecans-approach"><span class="octicon octicon-link"></span></a>Video:</h1>
Expand Down
Loading