Skip to content

Commit

Permalink
Changed markdown + links in /docs/about
Browse files Browse the repository at this point in the history
  • Loading branch information
atteggiani committed Apr 26, 2024
1 parent d4fdcde commit 19ba635
Show file tree
Hide file tree
Showing 8 changed files with 38 additions and 63 deletions.
48 changes: 14 additions & 34 deletions docs/about/License.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode

# License

The ACCESS-Hive is made available under the [Creative Commons Attribution
Expand All @@ -6,45 +9,22 @@ license][cc-by-human]. The following is a human-readable summary of
license][cc-by-legal].

You are free to:
<ul>
<li>
<b>Share</b>
<br>
Copy and redistribute the material in any medium or format
</li>
<li>
<b>Adapt</b>
<br>
Remix, transform, and build upon the material
</li>
</ul>

- **Share**<br>
Copy and redistribute the material in any medium or format
- **Adapt**<br>
Remix, transform, and build upon the material

for any purpose, even commercially.

The licensor cannot revoke these freedoms as long as you follow the
license terms.

Under the following terms:
<ul>
<li>
<b>Attribution</b>
<br>
You must give appropriate credit (mentioning that your work is derived from work that is Copyright © ACCESS-NRI and, where practical, linking to **https://www.access-nri.org.au/**), provide a [link to the license][cc-by-human], and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
</li>
<li>
<b>No additional restrictions</b>
<br>
You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. With the understanding that:
<ul>
<li>
You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
</li>
<li>
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
</li>
</ul>
</li>
</ul>

[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
- **Attribution**<br>
You must give appropriate credit (mentioning that your work is derived from work that is Copyright © ACCESS-NRI and, where practical, linking to **https://www.access-nri.org.au/**), provide a link to the [license][cc-by-human], and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
- **No additional restrictions**<br>
You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. With the understanding that:
- You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
- No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
22 changes: 11 additions & 11 deletions docs/about/contact.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# Contact

<img src = "/assets/contact-img.jpg" class="intro-img img-cover with-border" loading="lazy"/>
![Contact](/assets/contact-img.jpg){: class="intro-img img-cover with-border" loading="lazy"}

ACCESS-Hive is an initiative of the <a href="https://www.access-nri.org.au/about/what-is-access-nri/" target="_blank">Australian Earth-System Simulator (ACCESS-NRI)</a>.
ACCESS-Hive is an initiative of the [Australian Earth-System Simulator (ACCESS-NRI)](https://www.access-nri.org.au/about/what-is-access-nri).

If you encounter problems/bugs about the content of ACCESS-Hive or you want to contribute, check <a href="/about/contribute">how to contribute</a>.
If you encounter problems/bugs about the content of ACCESS-Hive, or you want to contribute, refer to [how to contribute](/about/contribute).

Check the <a href="/about/user_support">User Support page</a> if you need help, and for information on what is supported and by whom.
Check the [User Support page](/about/user_support) if you need help, and for information on what is supported and by whom.

Join the <a href="https://forum.access-hive.org.au/" target="_blank">ACCESS-Hive Community Forum</a> and find previous related discussions about the hive or the resources listed here, or start your own and make contacts with your community.
Join the [ACCESS-Hive Community Forum](https://forum.access-hive.org.au/) and find previous related discussions about the hive or the resources listed here, or start your own and make contacts with your community.

## Places where you can find the ACCESS-NRI team

:fontawesome-brands-discourse:{ .forum } <a href="https://forum.access-hive.org.au/" target="_blank">ACCESS-Hive Community Forum</a>
:fontawesome-brands-discourse: [ACCESS-Hive Community Forum](https://forum.access-hive.org.au/)

:fontawesome-brands-github:{ .github } <a href="https://github.com/ACCESS-NRI/" target="_blank">ACCESS-NRI Github</a>
:fontawesome-brands-github: [ACCESS-NRI Github](https://github.com/ACCESS-NRI/)

:fontawesome-brands-twitter:{ .twitter } <a href="https://twitter.com/ACCESS_NRI" target="_blank">ACCESS-NRI Twitter</a>
:fontawesome-brands-twitter: [ACCESS-NRI Twitter](https://twitter.com/ACCESS_NRI)

:fontawesome-brands-linkedin:{ .linkedin} <a href="https://www.linkedin.com/in/access-nri" target="_blank">ACCESS-NRI LinkedIn</a>
:fontawesome-brands-linkedin: [ACCESS-NRI LinkedIn](https://www.linkedin.com/in/access-nri)

:fontawesome-brands-slack:{ .slack} <a href="https://access-nri.slack.com" target="_blank">ACCESS-NRI Slack channel</a>
:fontawesome-brands-slack: [ACCESS-NRI Slack channel](https://access-nri.slack.com)

[^1]: _"Contact" image source_: <a href="https://www.freepik.com/free-vector/contact-concept-landing-page_5155590.htm#page=5&query=contact%20cartoon&position=6&from_view=search&track=ais">Image by pch.vector</a> on Freepik
[^1]: _"Contact" image source_: [Image by pch.vector](https://www.freepik.com/free-vector/contact-concept-landing-page_5155590.htm#page=5&query=contact%20cartoon&position=6&from_view=search&track=ais) on Freepik
6 changes: 3 additions & 3 deletions docs/about/contribute/contribute_on_github.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

## Let's get started!

This documentation is written in Markdown format and is based on the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)</a> theme, which is built on top of [MkDocs](https://www.mkdocs.org) static site generator.<br>
This documentation is written in Markdown format and is based on the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme, which is built on top of [MkDocs](https://www.mkdocs.org) static site generator.<br>
For a quick reference on how to use Markdown syntax you can refer to the [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/).

## Raise a GitHub Issue

All contributions need to have an associated [Github issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/)</a> that explains the content and importance of the contribution.<br>
All contributions need to have an associated [Github issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/) that explains the content and importance of the contribution.<br>
To raise an issue, create a New Issue in the [ACCESS-Hive Github repository issue page](https://github.com/ACCESS-NRI/access-hive.org.au/issues). Feel free to assign that issue to yourself if you intend to work on it.

## Fork the ACCESS-Hive GitHub repository
Expand Down Expand Up @@ -118,7 +118,7 @@ Your documentation will be built on http://127.0.0.1:8000. Open this URL in your

Once the changes on your local branch `spongebob/fix-hive-title-issue-234` are ready to be integrated with the `development` branch, [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) and GitHub will automatically build a preview of the documentation using [GitHub Actions](https://docs.github.com/en/actions).

![GitHub preview](/assets/github-preview-link.png){: class="example-img" }
![GitHub preview](/assets/github-preview-link.png){: class="example-img" loading="lazy"}

After a PR is created and tested, feel free to ask for reviews by tagging the ACCESS-Hive/reviewers team and reply if any changes are being requested in the PR.

Expand Down
4 changes: 2 additions & 2 deletions docs/about/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ Contributions are encouraged from any member of the community regarding any aspe
</a>
</div>

[^1]: _"How to contribute" sample image source_: <a href="https://www.freepik.com/free-vector/team-crisis-managers-solving-businessman-problems-employees-with-lightbulb-unraveling-tangle-vector-illustration-teamwork-solution-management-concept_10613678.htm#query=teamwork%20cartoon&position=18&from_view=keyword&track=ais" target="_blank">Image by pch.vector</a> on Freepik
[^3]: _"Contribute to github?" sample image source_:<a href="https://www.freepik.com/free-vector/business-idea-generation-plan-development-pensive-man-with-lightbulb-cartoon-character-technical-mindset-entrepreneurial-mind-brainstorming-process_11668582.htm#page=9&query=idea%20cartoon&position=30&from_view=search&track=ais" target="_blank">Image by vectorjuice</a> on Freepik
[^1]: _"How to contribute" sample image source_: [Image by pch.vector](https://www.freepik.com/free-vector/team-crisis-managers-solving-businessman-problems-employees-with-lightbulb-unraveling-tangle-vector-illustration-teamwork-solution-management-concept_10613678.htm#query=teamwork%20cartoon&position=18&from_view=keyword&track=ais) on Freepik
[^2]: _"Contribute to github?" sample image source_: [Image by vectorjuice](https://www.freepik.com/free-vector/business-idea-generation-plan-development-pensive-man-with-lightbulb-cartoon-character-technical-mindset-entrepreneurial-mind-brainstorming-process_11668582.htm#page=9&query=idea%20cartoon&position=30&from_view=search&track=ais) on Freepik
8 changes: 4 additions & 4 deletions docs/about/index.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# About

<div class="card-container">
<a href="contact" class="vertical-card aspect-ratio1to1">
<a href="/about/contact" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
<img src="/assets/contact_logo.png" alt="Contacts" class="img-contain white-background with-padding"></img>
</div>
<div class="card-text-container bold">Contact</div>
</a>
<a href="user_support" class="vertical-card aspect-ratio1to1">
<a href="/about/user_support" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
<img src="/assets/user_support_image.png" alt="ACCESS-NRI Support" class="img-contain white-background"></img>
</div>
<div class="card-text-container bold">User support</div>
</a>
<a href="contribute" class="vertical-card aspect-ratio1to1">
<a href="/about/contribute" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
<img src="/assets/contribute_image.png" alt="Contribute" class="img-cover white-background"></img>
</div>
<div class="card-text-container bold">How to contribute</div>
</a>
<a href="License" class="vertical-card aspect-ratio1to1">
<a href="/about/License" class="vertical-card aspect-ratio1to1">
<div class="card-image-container" style="container-type:size;">
<div class="icon-cc white-background" style="font-size: 85cqh; color: black; height: 100%; width: 100%; display: flex; justify-content: center; align-items: center; border-radius: 0.35rem;"></div>
</div>
Expand Down
5 changes: 0 additions & 5 deletions docs/about/policies.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/about/user_support/ask_on_forum.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can start a new discussion topic on the [Hive Forum] in just 3 simple steps:

:material-tag:{: class="twemoji icon-before-text nri-light-blue-color"} [Tag the request with the label `help`](https://forum.access-hive.org.au/docs?topic=846)

![Ask on forum](/assets/ask-on-forum-diagram.png){: class="white-background with-border example-img"}
![Ask on forum](/assets/ask-on-forum-diagram.png){: class="white-background with-border example-img" loading="lazy"}

## Next steps...

Expand All @@ -32,4 +32,4 @@ After a discussion topic is posted on the forum, the ACCESS-NRI and community ex

:fontawesome-regular-circle-check:{: class="twemoji icon-before-text nri-green-color"} Request is solved.

![ACCESS-NRI Support Model](/assets/access-nri-support.png){: class="white-background with-border example-img"}
![ACCESS-NRI Support Model](/assets/access-nri-support.png){: class="white-background with-border example-img" loading="lazy"}
4 changes: 2 additions & 2 deletions docs/about/user_support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Click on the questions to unfold the answers.
ACCESS-Hive is the open portal where ACCESS-NRI provides documentation for the ACCESS user community.
The Hive forum is the place where the ACCESS user community and its scientific working groups can exchange ideas and provide support.

![Diagram showing how ACCESS-NRI and the Climate Research Working Groups engage with each other through the ACCESS-Hive and the Hive Forum](/assets/access_hive_links.png){: class="with-border centered" style="width: 50%" }
![Diagram showing how ACCESS-NRI and the Climate Research Working Groups engage with each other through the ACCESS-Hive and the Hive Forum](/assets/access_hive_links.png){: class="with-border centered" style="width: 50%" loading="lazy"}

??? question "What is the difference between _model_, _model component_, and _model configuration_?"
A **model component** (sometimes referred to as component) is a codebase that is typically compiled into a single executable. It usually runs independently and communicates with other components via a coupler.
Expand All @@ -31,7 +31,7 @@ Click on the questions to unfold the answers.

Climate science - like all science - is based on the comparison of different models and hypothesis with observational data. We provide or support the frameworks to perform such comparisons as part of the **model evaluation**. The different model hypotheses, or more practically speaking *model experiments*, are created by executing different model configurations with different setups; for example by perturbing initial conditions or by adding new physical prescriptions to the models.

![Diagram showing how running ACCESS model configurations with different setups create different experiments](/assets/how_does_it_work_together.png){: class="with-border centered" style="width: 75%"}
![Diagram showing how running ACCESS model configurations with different setups create different experiments](/assets/how_does_it_work_together.png){: class="with-border centered" style="width: 75%" loading="lazy"}

??? question "What is a control experiment? Why are they important?"
A **control experiment** (sometimes also called a "control run") is an experiment that is designed to be used as a comparison against which perturbation experiments can be compared.
Expand Down

0 comments on commit 19ba635

Please sign in to comment.