Skip to content

Commit

Permalink
Changed contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
atteggiani committed Sep 3, 2023
1 parent 484c8a6 commit b7e9b37
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 16 deletions.
14 changes: 6 additions & 8 deletions docs/about/contribute/contribute_on_github.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@

## Let's get started!

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>
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

Expand All @@ -31,10 +29,10 @@ To raise an issue, create a New Issue in the <a href="https://github.com/ACCESS-

## Fork 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> ACCESS-Hive's 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
27 changes: 19 additions & 8 deletions docs/about/contribute/index.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,38 @@
# Contribute to ACCESS-Hive

<img class="rectangular-img img-cover with-border" src="../../assets/how-to-contribute-img.jpg" loading="lazy"/>
<img class="rectangular-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>
Expand Down

0 comments on commit b7e9b37

Please sign in to comment.