diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index 704c73023..94a670688 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -9,9 +9,6 @@ { "pattern": "linkedin.com" }, - { - "pattern": "https://opus.nci.org.au/display/Help/ARE+User+Guide" - }, { "pattern": "^http://www.bom.gov.au" } diff --git a/README.md b/README.md index 6de839851..39efd1907 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,42 @@ # ACCESS-Hive -[![ACCESS-Hive Badge](docs/assets/badge.svg)](https://access-hive.org.au/) +[![ACCESS-Hive Badge](docs/assets/badge.svg)][website] [![github-contributors](https://img.shields.io/github/contributors/ACCESS-Hive/access-hive.github.io?color=blue&style=plastic)][github-repo] [![forum-users](https://img.shields.io/discourse/users?color=blue&label=forum&server=https%3A%2F%2Fforum.access-hive.org.au&style=plastic)][forum] -[![Link Check](https://github.com/ACCESS-Hive/access-hive.github.io/actions/workflows/scheduled_link_check.yml/badge.svg)](https://github.com/ACCESS-Hive/access-hive.github.io/actions/workflows/scheduled_link_check.yml) Documentation hub for the Earth System models, ACCESS, and their community. -This repository uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to build the website which accessible at this URL: - +This repository uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to build the website which accessible at this URL:
https://access-hive.org.au/ +# How to Contribute If you wish to add documentation to the ACCESS-Hive website see the [contribution guide](https://access-hive.org.au/about/contribute/) for instructions. -# How to Contribute [Draft TEST] - -- Pull the latest version of `development` branch locally by using the following commands: +## Styling guidelines for contribution +Please follow the guidelines below so as to make the Hive consistent among the pages contributed by different people. + +- Always prefer HTML syntax to Markdown when possible; +- Titles/subtitles should NOT include: code lines/blocks, bold (titles are usually already bold), italic, links; +- Code lines/blocks need to be used for lines/blocks of code and terminal commands; +- Italic needs to be used when referring to specific proper nouns (for example *Gadi* or *Accessdev*); +- Bold can be used to highlight some words (please do not overuse it); +- Links should be coded using HTML syntax.
External links (links that go to a website other than https://access-hive.org.au) need to specify `target="_blank"` (see HTML cheatsheet below); +- To signal an important note within the text, consider using a "warning note" (see HTML cheatsheet below); +- Instructions for different versions (for example different operative systems or different model versions) can be rendered using tabs (see HTML cheatsheet below); + + +### HTML Cheatsheet for the Hive +|Style|HTML Syntax|Rendered example| +|---|---|---| +|**Bold**|\bold\|**bold**| +|**Italic**|\italic\|*italic*| +|**Code line**|\this is a code line\|`this is a code line`| +|**Code block**|\
\this is a code block\\
|
this is a code block
| +|**Link (internal)**|\ACCESS-Hive link\|ACCESS-Hive link| +|**Link (external)**|\Google link\|Google link| +|**Warning note**|\
this is a warning note\
|![warning note](docs/assets/assets_for_readme/warning_note.png)| +|**Tabs**|\
\\\
\
\
Content for tab1\
\
Content for tab2\
\
|![tabs](docs/assets/assets_for_readme/tabs.gif)| + + # License -The ACCESS-Hive site is covered by [the CC-BY 4.0 license][License]. +The ACCESS-Hive site is covered by the [CC-BY 4.0 license](https://creativecommons.org/licenses/by/4.0/legalcode). However, the material linked to from ACCESS-Hive is covered by various licensing agreements. Our users should directly refer to the terms and conditions of any material they are using to understand their rights and responsibilities. -[License]: License.md +[website]: https://access-hive.org.au [github-repo]: https://github.com/ACCESS-Hive/access-hive.github.io.git [forum]: https://forum.access-hive.org.au diff --git a/docs/about/index.md b/docs/about/index.md index be6ebc748..15f2c9900 100644 --- a/docs/about/index.md +++ b/docs/about/index.md @@ -19,7 +19,7 @@
How to contribute
- +
diff --git a/docs/assets/assets_for_readme/tabs.gif b/docs/assets/assets_for_readme/tabs.gif new file mode 100644 index 000000000..3839c5ade Binary files /dev/null and b/docs/assets/assets_for_readme/tabs.gif differ diff --git a/docs/assets/assets_for_readme/warning_note.png b/docs/assets/assets_for_readme/warning_note.png new file mode 100644 index 000000000..859fefda0 Binary files /dev/null and b/docs/assets/assets_for_readme/warning_note.png differ diff --git a/docs/getting_started/first_steps.md b/docs/getting_started/first_steps.md index 865d5d576..e697c6913 100644 --- a/docs/getting_started/first_steps.md +++ b/docs/getting_started/first_steps.md @@ -53,11 +53,11 @@ Before you login to Gadi, you need to possess the following prerequisites