Skip to content

Commit 92b62d4

Browse files
infotrophinfotroph
authored
Merge pull request #126 from PecanProject/update-doc-versions
add recent and upcoming doc releases; update main branch links to "latest"
2 parents fd3edab + 545aecd commit 92b62d4

File tree

10 files changed

+159
-21
lines changed

10 files changed

+159
-21
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ This describes how to add or modify the Website's content.
8585
This is an open source project and contributions are what make an open source community.
8686
Everyone is welcome to contribute to this project.
8787

88-
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.
88+
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.
8989

9090
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.
9191

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

210210
### Optimising Documentation
211211

212-
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.
212+
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.
213213
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.
214214

215215
### Adding tutorials section

‎docusaurus.config.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ module.exports = {
7171
items: [
7272
{
7373
label: "Tutorial",
74-
to: "/documentation/master",
74+
to: "/documentation/latest",
7575
className: "footer-docs-link",
7676
},
7777
],

‎src/pages/documentation.js‎

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ function Documentation() {
66
return (
77
<Layout title="documentation">
88
<div className={styles.aboutContainer}>
9+
<div className={clsx(styles.cardContainer)}>
10+
{" "}
11+
<div class={clsx("card-demo", styles.aboutCard)}>
12+
<div class="card">
13+
<div class="card__header" style={{ textAlign: "center" }}>
14+
15+
<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>
16+
17+
</div>
18+
<div class="card__body">
19+
<p>
20+
<a href="documentation/develop" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest stable code (DEVELOP BRANCH).</u></a>
21+
</p>
22+
</div>
23+
</div>
24+
</div>
25+
</div>
926
<div className={clsx(styles.cardContainer)}>
1027
{" "}
1128
<div class={clsx("card-demo", styles.aboutCard)}>
@@ -16,7 +33,7 @@ function Documentation() {
1633
</div>
1734
<div class="card__body">
1835
<p>
19-
<a href="documentation/master" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest release (MASTER BRANCH).</u></a>
36+
<a href="documentation/latest" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest release (MAIN BRANCH).</u></a>
2037
</p>
2138
</div>
2239
</div>
@@ -28,12 +45,43 @@ function Documentation() {
2845
<div class="card">
2946
<div class="card__header" style={{ textAlign: "center" }}>
3047

31-
<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>
48+
<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>
49+
</div>
50+
<div class="card__body">
51+
<p>
52+
<a href="documentation/v1_10_0" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.10.0.</u></a>
53+
</p>
54+
</div>
55+
</div>
56+
</div>
57+
</div>
58+
<div className={clsx(styles.cardContainer)}>
59+
{" "}
60+
<div class={clsx("card-demo", styles.aboutCard)}>
61+
<div class="card">
62+
<div class="card__header" style={{ textAlign: "center" }}>
3263

64+
<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>
3365
</div>
3466
<div class="card__body">
3567
<p>
36-
<a href="documentation/develop" class="text-size-20 text-m-size-16" ><u>Documentation consistent with latest stable code (DEVELOP BRANCH).</u></a>
68+
<a href="documentation/v1_9_0" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.9.0.</u></a>
69+
</p>
70+
</div>
71+
</div>
72+
</div>
73+
</div>
74+
<div className={clsx(styles.cardContainer)}>
75+
{" "}
76+
<div class={clsx("card-demo", styles.aboutCard)}>
77+
<div class="card">
78+
<div class="card__header" style={{ textAlign: "center" }}>
79+
80+
<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>
81+
</div>
82+
<div class="card__body">
83+
<p>
84+
<a href="documentation/v1_8_0" class="text-size-20 text-m-size-16" ><u>Documentation consistent with release 1.8.0.</u></a>
3785
</p>
3886
</div>
3987
</div>

src/pages/documentation/master.js renamed to src/pages/documentation/latest.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ import React from "react";
22
import Layout from "@theme/Layout";
33
import "./documentation.css";
44
import Foot from "@docusaurus/Head";
5-
function Master() {
5+
function Latest() {
66
return (
77
<>
8-
<Layout title="Master" >
8+
<Layout title="Latest" >
99
<Foot>
1010
<body className="documentation"></body>
1111
</Foot>
1212
<iframe
13-
src="https://pecanproject.github.io/pecan-documentation/master/"
13+
src="https://pecanproject.github.io/pecan-documentation/latest/"
1414
style={{ border: "none" }}
1515
width="100%"
1616
height="100%"
@@ -29,4 +29,4 @@ function Master() {
2929
);
3030
}
3131

32-
export default Master;
32+
export default Latest;

‎src/pages/documentation/v1_10_0.js‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import React from "react";
2+
import Layout from "@theme/Layout";
3+
import "./documentation.css";
4+
import Foot from "@docusaurus/Head";
5+
function V1_10_0() {
6+
return (
7+
<>
8+
<Layout title="V1_10_0">
9+
<Foot>
10+
<body className="documentation"></body>
11+
</Foot>
12+
<iframe
13+
src="https://pecanproject.github.io/pecan-documentation/v1.10.0"
14+
style={{ border: "none" }}
15+
width="100%"
16+
height="100%"
17+
id="iFrame3"
18+
>
19+
<p>
20+
<a href="/en-US/docs/Glossary">
21+
Fallback link for browsers that don't support iframes
22+
</a>
23+
</p>
24+
</iframe>
25+
</Layout>
26+
</>
27+
);
28+
}
29+
30+
export default V1_10_0;

‎src/pages/documentation/v1_8_0.js‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import React from "react";
2+
import Layout from "@theme/Layout";
3+
import "./documentation.css";
4+
import Foot from "@docusaurus/Head";
5+
function V1_8_0() {
6+
return (
7+
<>
8+
<Layout title="V1_8_0">
9+
<Foot>
10+
<body className="documentation"></body>
11+
</Foot>
12+
<iframe
13+
src="https://pecanproject.github.io/pecan-documentation/v1.8.0"
14+
style={{ border: "none" }}
15+
width="100%"
16+
height="100%"
17+
id="iFrame3"
18+
>
19+
<p>
20+
<a href="/en-US/docs/Glossary">
21+
Fallback link for browsers that don't support iframes
22+
</a>
23+
</p>
24+
</iframe>
25+
</Layout>
26+
</>
27+
);
28+
}
29+
30+
export default V1_8_0;

‎src/pages/documentation/v1_9_0.js‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import React from "react";
2+
import Layout from "@theme/Layout";
3+
import "./documentation.css";
4+
import Foot from "@docusaurus/Head";
5+
function V1_9_0() {
6+
return (
7+
<>
8+
<Layout title="V1_9_0">
9+
<Foot>
10+
<body className="documentation"></body>
11+
</Foot>
12+
<iframe
13+
src="https://pecanproject.github.io/pecan-documentation/v1.9.0"
14+
style={{ border: "none" }}
15+
width="100%"
16+
height="100%"
17+
id="iFrame3"
18+
>
19+
<p>
20+
<a href="/en-US/docs/Glossary">
21+
Fallback link for browsers that don't support iframes
22+
</a>
23+
</p>
24+
</iframe>
25+
</Layout>
26+
</>
27+
);
28+
}
29+
30+
export default V1_9_0;

‎src/pages/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ function HomepageHeader() {
1515
<div className={styles.buttons}>
1616
<Link
1717
className="button button--secondary button--lg"
18-
to="/documentation/master"
18+
to="/documentation/latest"
1919
>
2020
Get started
2121
</Link>

‎src/pages/news.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1475,7 +1475,7 @@ function News() {
14751475
A few functions have already been added to the <a
14761476
href="https://github.com/ropensci/traits/">rOpensci traits
14771477
package</a> that can be found in the file <a
1478-
href="https://github.com/ropensci/traits/blob/master/R/betydb.R">R/betydb.R</a>.
1478+
href="https://github.com/ropensci/traits/blob/main/R/betydb.R">R/betydb.R</a>.
14791479
</p>
14801480
If you can help resolve open issues, implement new functionality, and
14811481
write vignettes please contact [email protected], submit a pull request

‎src/pages/tutorials.js‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -118,25 +118,25 @@ function Tutorials() {
118118

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

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

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

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

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

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

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

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

135135
<h3>Concepts</h3>
136136

137-
<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>
137+
<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>
138138

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

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

0 commit comments

Comments
 (0)