Skip to content

Engelca/1135 1178 1179 improve access ram3 documentation#1181

Open
engelca wants to merge 14 commits into
developmentfrom
engelca/1135-1178-1179-improve-access-ram3-documentation
Open

Engelca/1135 1178 1179 improve access ram3 documentation#1181
engelca wants to merge 14 commits into
developmentfrom
engelca/1135-1178-1179-improve-access-ram3-documentation

Conversation

@engelca

@engelca engelca commented Apr 10, 2026

Copy link
Copy Markdown
Contributor

ACCESS-Hive Docs

Description

Changes were required to the ACCESS-Hive ACCESS-rAM3 (affecting the run-a-model, model landing page and the generic rose/cylc page) to cope with removing OSTIA from the standard example AND for including the revision number in the rose/cylc checkout. The website was simplified by moving sections of text around (within pages and between pages to improve readability as well).

Fixes #1135

Fixes #1178

Please note that it introduces a inconsistency in the rose_cylc.md file that I would like to discuss because:

  • the rose commands are longer in rose_cylc.md so they can be run from anywhere
  • the commands shifted into rose_cylc.md are written as though they are being executed from within the rose/ directory.
  • the text would need to choose one or the other, or explain the difference.
  • I wasn't sure what the preference would be.

Still to do:

  • switch the USE_OSTIA to .FALSE. in the demonstration suite.
  • switch the localhost to localhost instead of gadi.nci.org.au

Type of change

  • [X ] New link / content

Checklist:

  • [ X ] The new content is accessible and located in the appropriate section
  • [ X ] My changes do not break navigation and do not generate new warnings
    - There are some broken links and I am not sure if they are new.
  • [ X ] I have checked that the links are valid and point to the intended content
  • [ X ] I have checked my code/text and corrected any misspellings

@github-actions

github-actions Bot commented Apr 10, 2026

Copy link
Copy Markdown
PR Preview
🚀 Preview of PR head commit efb7306 deployed to https://docs.access-hive.org.au/pr-previews/1181
2026-07-08 03:23 AEST
Preview generated through the Deploy to GitHub Pages workflow run 28885468113.

@engelca engelca marked this pull request as ready for review April 10, 2026 07:11
@engelca engelca requested a review from a team as a code owner April 10, 2026 07:11
@engelca engelca requested a review from paigem April 10, 2026 07:12
paigem
paigem previously approved these changes May 11, 2026

@paigem paigem left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much @engelca for this PR! It looks great - I think this update increases understandability noticeably - so thank you! I just suggest a couple minor wording updates, but otherwise I think this is ready to merge.

With the addition of revision in the rose/cylc page, we will want to ensure we make it clear what users should do for the revision in the docs for other models that use rose/cylc. Not in scope for this PR, but something I have noted and will action when we revamp the rose/cylc page. 😊

Comment thread docs/models/run_a_model/run_access-ram3.md Outdated
Comment thread docs/models/run_a_model/run_access-ram3.md Outdated
Co-authored-by: Paige Martin <paige.martin@anu.edu.au>
Co-authored-by: Paige Martin <paige.martin@anu.edu.au>
@engelca

engelca commented May 11, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @paigem. I have accepted your two suggestions. Good point about "two" not multiple.

I will update the suite to be have USE_OSTIA = False later this morning.

@paigem

paigem commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Just a quick update to say that we will add a couple more edits to this PR before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants