Skip to content

Commit

Permalink
Merge pull request #562 from ACCESS-Hive/davide/are
Browse files Browse the repository at this point in the history
Davide/are
  • Loading branch information
atteggiani authored Sep 3, 2023
2 parents f59281f + 687e235 commit a652b75
Show file tree
Hide file tree
Showing 59 changed files with 1,500 additions and 667 deletions.
53 changes: 33 additions & 20 deletions docs/about/License.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,46 @@ license][cc-by-human]. The following is a human-readable summary of
(and not a substitute for) the [full legal text of the CC BY 4.0
license][cc-by-legal].

You are free:

* to **Share**---copy and redistribute the material in any medium or format
* to **Adapt**---remix, transform, and build upon the material
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>

for any purpose, even commercially.

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

Under the following terms:

* **Attribution**---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**---You may not apply legal terms or
technological measures that legally restrict others from doing
anything the license permits. With the understanding that:

Notices:

* 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.
<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
7 changes: 0 additions & 7 deletions docs/about/code_of_conduct.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/about/contact.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contact

<img src = "../../assets/contact-img.jpg" class="rectangular-img img-cover with-border"></img>
<img src = "/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>.

Expand Down
33 changes: 12 additions & 21 deletions docs/about/contribute/contribute_on_github.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,24 @@
</div>
</div>

## Let's get started!
## Let's get started!

<terminal-window>
<terminal-line data="input">git commit -m "Let's 'git' started!!!"</terminal-line>
<terminal-line></terminal-line>
<terminal-line data="progress"></terminal-line>
</terminal-window>

This documentation is written in Markdown format and is based on the <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank">Material for MkDocs</a> documentation framework, which is built on top of <a href="https://www.mkdocs.org" target="_blank">MkDocs</a> static site generator. Please refer to this <a href="https://www.markdownguide.org/cheat-sheet/" target="_blank">cheatsheet</a> for a quick reference to basic markdown syntax, which is used by <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank">Material for MkDocs</a> theme used in this website.

<div class="markdown-notes">
<b>Note:</b> Since, ACCESS-Hive curates useful resources for making comprehensive guides for the ACCESS community, it includes content that is not curated and hosted by ACCESS-NRI.
</div>

## Become a member of the ACCESS-Hive GitHub repository

The <b>ACCESS-Hive user portal</b> is open to receiving contributions from anyone relating to different aspects of the website, including <i>bug fixes</i>, <i>content additions</i>, and <i>enhancement suggestions</i>. The <a href="https://github.com/ACCESS-Hive" target="_blank">ACCESS-Hive GitHub organisation</a> members would have write access to the <a href="https://github.com/ACCESS-Hive/access-hive.github.io/" target="_blank">ACCESS-Hive repository</a>, and they can contribute by creating their own branches instead of maintaining their individual forks.

Hence, we encourage you to become a member of the <a href="https://github.com/ACCESS-Hive" target="_blank">ACCESS-Hive GitHub organisation</a> by replying to <a href="https://github.com/ACCESS-Hive/access-hive.github.io/issues/179" target="_blank">this issue</a> and ask to be invited to join the organisation.
This documentation is written in Markdown format and is based on the <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank">Material for MkDocs</a> theme, which is built on top of <a href="https://www.mkdocs.org" target="_blank">MkDocs</a> static site generator.
<br>
For a quick reference on how to use Markdown syntax you can refer to the <a href="https://www.markdownguide.org/cheat-sheet/" target="_blank">Markdown Cheat Sheet</a>.

## Raise a GitHub Issue

Once you are a member of the <a href="https://github.com/ACCESS-Hive" target="_blank">ACCESS-Hive GitHub organisation</a>, for all additions or modifications to the ACCESS-Hive site, it is recommended to start by opening an <a href="https://github.com/ACCESS-Hive/access-hive.github.io/issues">issue</a> in the ACCESS-Hive GitHub repository. Feel free to <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/" target="_blank">assign that issue</a> to yourself if you intend to work on that issue.
All contributions need to have an associated <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/" target="_blank">Github issue</a> that explains the content and importance of the contribution.
<br>
To raise an issue, create a New Issue in the <a href="https://github.com/ACCESS-Hive/access-hive.github.io/issues" target="_blank">ACCESS-Hive Github repository issue page</a>. Feel free to assign that issue to yourself if you intend to work on it.

## Fork the ACCESS-Hive GitHub repository

## Clone the ACCESS-Hive GitHub repository
After raising a Github issue about your contribution, you need to <a href="https://docs.github.com/en/get-started/quickstart/fork-a-repo?platform=mac&tool=webui" target="_blank">fork</a> the <a href="https://github.com/ACCESS-Hive/access-hive.github.io" target="_blank">ACCESS-Hive Github repository</a>.

For cloning this repository onto your local computer, we encourage you to first add your local SSH keys to your GitHub profile.
## Clone the forked ACCESS-Hive GitHub repository locally
For cloning the forked repository onto your local computer, we encourage you to first add your local SSH keys to your GitHub profile.

To start with, if you have an <a href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys" target="_blank">existing SSH key</a>, then simply <a href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account" target="_blank">add this key to your github account</a>, and you are all set to clone the repository. In case you don't have the SSH keys set up on your local computer, it's easy to <a href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent" target="_blank">create a new SSH key locally</a>, and then <a href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account" target="_blank">feel free to link this key to your github account</a>.

Expand Down
32 changes: 21 additions & 11 deletions docs/about/contribute/index.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,42 @@
# Contribute to ACCESS-Hive

<img class="rectangular-img img-cover" src="../../assets/how-to-contribute-img.jpg">
<img class="intro-img img-cover with-border" src="/assets/github-how-to-contribute.jpg" loading="lazy"/ style="object-position: ">

ACCESS-Hive is an open user portal which hosts the documentation relevant to the Australian Community Climate and Earth System Simulator (ACCESS) community.

Contributions are encouraged from any member of the community regarding any aspect of the **ACCESS-Hive** website (which curates ACCESS documentation and its related resources) or the <a href="https://forum.access-hive.org.au" target="_blank">Hive Forum</a> (used for community discussions).
Contributions are encouraged from any member of the community regarding any aspect of the ACCESS-Hive user portal.

## How can I contribute?

Anyone is welcome to contribute towards improving the **ACCESS-Hive** user portal. The following section lists the contribution tasks that we are most interested in receiving community help with. Please consider helping with one or more tasks below, and we are looking towards receiving your very first contribution for the **ACCESS-Hive**!

<div class="card-container">
<a href="/about/contribute/contribute_on_github" class="horizontal-card">
<a href="https://github.com/ACCESS-Hive/access-hive.github.io/issues/new?assignees=&labels=External&projects=&template=simple-issue-template.md&title=" class="horizontal-card" target="_blank">
<div class="card-image-container">
<img class="img-contain white-background" src="/assets/github-how-to-contribute.jpg">
<img class="img-contain white-background" src="/assets/how-to-contribute-img.jpg">
</div>
<div class="card-text-container with-padding">
<div class="bold">
Quick Contribution
</div>
<span class="with-padding">
Suggest an idea, propose bug fixes, or flag missing content by raising a GitHub issue.
</span>
</div>
</a>
<a href="/about/contribute/contribute_on_github" class="horizontal-card">
<div class="card-image-container" style="container-type:size;">
<div class="fa-brands fa-github 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>
<div class="card-text-container with-padding">
<div class="bold">
<i class="fa-brands fa-github"></i>
Contribute on Github!
Write your own content
</div>
<span class="with-padding">
Suggest an idea, propose bug fixes, or flag missing content on <b>ACCESS-Hive GitHub repo</b>!
Contribute to the ACCESS-Hive user portal by adding content to the ACCESS-Hive Github repository yourself.
</span>
</div>
</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">Image by pch.vector</a> on Freepik
[^2]: _"Have a question or need help?" sample image source_:<a href="https://www.freepik.com/free-vector/businessmans-hand-holding-question-mark-person-asking-answer-help-support-flat-vector-illustration-faq-interrogation-difficulty-concept-banner-website-design-landing-web-page_26921528.htm#page=3&query=question%20cartoon&position=29&from_view=search&track=ais">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">Image by vectorjuice</a> on Freepik
[^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
34 changes: 34 additions & 0 deletions docs/about/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# About

<div class="card-container">
<a href="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">
<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">
<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">
<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>
<div class="card-text-container bold">License</div>
</a>
<a href="https://www.access-nri.org.au/community/access-nri-code-of-conduct/" target="_blank" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
<img src="/assets/code_of_conduct.jpeg" alt="Code of conduct" class="img-cover"></img>
</div>
<div class="card-text-container bold">Code of conduct</div>
</a>
</div>
4 changes: 1 addition & 3 deletions docs/about/user_support/ask_on_forum.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,4 @@ After a discussion topic is posted on the forum, the ACCESS-NRI and community ex

<i class="fa-regular fa-circle-check nri-green-color with-padding fa-sm"></i> Request is solved.

<img class="white-background with-border" src="/assets/access-nri-support.png">

We highly appreciate any contributions received from our community and do our best to engage the wider community through shared <a href="https://forum.access-hive.org.au" target="_blank">Hive Forum</a> activities. Additionally, if you would like to make contributions on GitHub, please consider following <a href="/about/contribute/contribute_on_github">these</a> guidelines before submitting a new feature request, improvement ideas or bug reports. We would love to have your contributions onboard for the <a href="https://github.com/ACCESS-Hive/access-hive.github.io/">ACCESS-Hive GitHub repo</a>!
<img class="white-background with-border" src="/assets/access-nri-support.png">
4 changes: 2 additions & 2 deletions docs/about/user_support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

On this page we answer frequently asked questions (FAQs), and also give additional information for support, in case your question is not yet answered.

## Frequently Asked Questions
## Frequently Asked Questions (FAQ)

Click on the questions to unfold the answers.

Expand Down Expand Up @@ -55,7 +55,7 @@ Click on the questions to unfold the answers.

Go to our [**Model Data**](../model_evaluation/model_evaluation_model_catalogs/index.md) section on the ACCESS-Hive to learn how to find and access model data.

In any case, you need to have access to the specific projects and NCI itself in order to read the data. We explain this on our [**Getting Started Pages**](../getting_started/index.md).
In any case, you need to have access to the specific projects and NCI itself in order to read the data. We explain this on our [**Getting Started Pages**](../getting_started/first_steps.md).

??? abstract "What is the difference between _teams_ and _working groups_?"

Expand Down
Binary file added docs/assets/ACCESS_logo_rgb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/are_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/code_of_conduct.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/contact_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/contribute_image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/first_steps_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/jupyterlab_plus_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/launch_are_jupyterlab.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/launch_are_vdi_desktop.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added docs/assets/run_access_cm/Cylc_GUI_are.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/run_access_cm/Rose_GUI_are.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/run_access_cm/launch_are_vdi.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/session_delete_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/user_support_image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a652b75

Please sign in to comment.