/access-hive.org.au

Documentation hub for the Earth System models, ACCESS, and their community

Primary LanguageHTML

ACCESS-Hive

ACCESS-Hive Badge github-contributors forum-users

Documentation hub for the Earth System models, ACCESS, and their community.

This repository uses Material for MkDocs 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 for instructions.

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 <b>bold</b> bold
Italic <i>italic</i> italic
Code line <code>this is a code line</code> this is a code line
Code block <pre><code>this is a code block</code></pre> 
this is a code block
Link (internal) <a href="https://access-hive.org.au">ACCESS-Hive link</a> ACCESS-Hive link
Link (external) <a href="https://www.google.com" target="_blank">Google link</a> Google link⎋
Warning note <div class="note">this is a warning note<div> warning note
Tabs <div class="tabLabels" label="your-tab-label"><button>Tab1</button><button>Tab2</button></div><div class="tabContents" label="your-tab-label"><div>Content for tab1</div><div>Content for tab2</div></div> tabs

License

The ACCESS-Hive site is covered by the CC-BY 4.0 license.

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.