From b7e9b378af51b3f7b07122ea7fa308cbbb50c0e2 Mon Sep 17 00:00:00 2001 From: atteggiani Date: Sun, 3 Sep 2023 18:58:13 +1000 Subject: [PATCH] Changed contribute --- docs/about/contribute/contribute_on_github.md | 14 +++++----- docs/about/contribute/index.md | 27 +++++++++++++------ 2 files changed, 25 insertions(+), 16 deletions(-) diff --git a/docs/about/contribute/contribute_on_github.md b/docs/about/contribute/contribute_on_github.md index 349fdc4ba..4c7dbbaa5 100644 --- a/docs/about/contribute/contribute_on_github.md +++ b/docs/about/contribute/contribute_on_github.md @@ -17,11 +17,9 @@ ## Let's get started! -This documentation is written in Markdown format and is based on the Material for MkDocs documentation framework, which is built on top of MkDocs static site generator. Please refer to this cheatsheet for a quick reference to basic markdown syntax, which is used by Material for MkDocs theme used in this website. - -
- Note: 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. -
+This documentation is written in Markdown format and is based on the Material for MkDocs theme, which is built on top of MkDocs static site generator. +
+For a quick reference on how to use Markdown syntax you can refer to the Markdown Cheat Sheet. ## Raise a GitHub Issue @@ -31,10 +29,10 @@ To raise an issue, create a New Issue in the fork ACCESS-Hive's Github repository. - +After raising a Github issue about your contribution, you need to fork the ACCESS-Hive Github repository. -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 existing SSH key, then simply add this key to your github account, 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 create a new SSH key locally, and then feel free to link this key to your github account. diff --git a/docs/about/contribute/index.md b/docs/about/contribute/index.md index 3a7e8c1d2..a78a2b16d 100644 --- a/docs/about/contribute/index.md +++ b/docs/about/contribute/index.md @@ -1,27 +1,38 @@ # Contribute to ACCESS-Hive - + 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 Hive Forum (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**!
- +
- + +
+
+
+ Quick Contribution +
+ + Suggest an idea, propose bug fixes, or flag missing content by raising a GitHub issue. + +
+ + +
+
- - Contribute on Github! + Write your own content
- Suggest an idea, propose bug fixes, or flag missing content on ACCESS-Hive GitHub repo! + Contribute to the ACCESS-Hive user portal by adding content to the ACCESS-Hive Github repository yourself.