Restyling "How to run access-om2" page + Markdown restyling

atteggiani commented 3 months ago

The recently updated page "How to run ACCESS-OM2" had a few styling and formatting issues, that were making it not consistent with other pages in the website.

MODIFICATIONS SPECIFIC TO THE PAGE

[x] Reformat "References" using HTML to have the same styling as other pages in the website;
[x] A few rewording/additions/deletions (The structure of the page was left untouched, with "how to run" section coming before "how to modify")

MODIFICATIONS NOT SPECIFIC TO THE PAGE

[x] Modified styling guidelines in the README
[x] Changed CSS so that admonitions (!!! ... and ??? ... in markdown) have the desired style. From now on the admonitions can be used as described in the admonition documentation, with a few differences in the rendered style. Therefore, markdown syntax is encouraged for readability. More information about styling guidelines in the README.
[x] Other minor modifications

I have converted everything to Markdown. As you can see it's all Markdown, with the exception of virtual terminal windows and references (in the near future we will style references properly also in Markdown).

Feel free to comment on any wording/addition/deletion, or any other part you think needs changing.

Note: You will see a lot of files changed listed. Most of them are inside the fontello folder, for icons. The main file changed is the run-access-om.md.

Cheers

github-actions[bot] commented 3 months ago

PR Preview :---: 🛬 Link removed because the pull request was closed. 2024-05-01 13:57 AEST

aidanheerdegen commented 3 months ago

Could you rebase on development and force push? This contains a bunch of commits that have been merged already.

FYI, your commits aren't signed. See https://github.com/ACCESS-NRI/dev-docs/issues/23 for how to configure this.

atteggiani commented 3 months ago

Could you rebase on development and force push? This contains a bunch of commits that have been merged already.

FYI, your commits aren't signed. See ACCESS-NRI/dev-docs#23 for how to configure this.

@aidanheerdegen Done! Thank you for pointing out about the signed commits!

atteggiani commented 2 months ago

References also (almost entirely) written in markdown.

atteggiani commented 2 months ago

Do we also need to change anything in the ACCESS-OM Models section after the new ACCESS-OM2 configurations release?

@aidanheerdegen

atteggiani commented 2 months ago

Thanks @aidanheerdegen for the review.

I have updated the branch with your suggestions.

atteggiani commented 2 months ago

Just noticed line 103 (cd 1deg_jra55_ryf) is missing a prompt (needs data=input).

I also realised there is no instructions on how to get help. A link to the user support page (https://access-hive.org.au/about/user_support/) would be appropriate.

These are the form of words I used in the release notice. I think something like this is also worth including as well as the link above:

If you have questions about access-om2 create a topic in the COSIMA category on the ACCESS Hive Forum and tag it with access-om2. If you require assistance follow the guidelines for requesting help from ACCESS-NRI .

Fixed vitual terminal prompt, and added 'how to get help' section at the end. @aidanheerdegen

ACCESS-NRI / access-hive.org.au

Restyling "How to run access-om2" page + Markdown restyling #673