Skip to content

ACCESS-ISSM documentation#1090

Draft
lawrenceabird wants to merge 4 commits intodevelopmentfrom
lb/issm-docs
Draft

ACCESS-ISSM documentation#1090
lawrenceabird wants to merge 4 commits intodevelopmentfrom
lb/issm-docs

Conversation

@lawrenceabird
Copy link
Contributor

@lawrenceabird lawrenceabird commented Nov 27, 2025

DRAFT PR - NOT FOR REVIEW

Description

This PR supersedes #932. It includes an overhaul of the initial documentation for "How to run ACCESS-ISSM", as well updates the to ACCESS-ISSM overview

Type of change

  • New link / content

Checklist:

  • The new content is accessible and located in the appropriate section
  • My changes do not break navigation and do not generate new warnings
  • I have checked that the links are valid and point to the intended content
  • I have checked my code/text and corrected any misspellings

When your pull request is ready please request a review.

Unless there is a specific person you want your PR to be reviewd by, please select the Hive Docs Team: ACCESS-NRI/hivedocsteam. This ensures the load for reviewing pull requests is shared equitably.

@lawrenceabird lawrenceabird self-assigned this Nov 27, 2025
@lawrenceabird lawrenceabird added the ✏️ documentation Improvements or additions to documentation label Nov 27, 2025
@github-actions
Copy link

github-actions bot commented Nov 27, 2025

PR Preview
🚀 Preview of PR head commit f5534b2 deployed to https://docs.access-hive.org.au/pr-previews/1090
2026-02-20 10:53 AEDT
Preview generated through the Deploy to GitHub Pages workflow run 22205172460.

@headmetal
Copy link
Contributor

Looking good @lawrenceabird

A couple of thoughts as discussed:

Prerequisites

  • Do we want to put a short description next to each NCI project we are asking users to join so they know what they are joining / understand the reason we are asking? We do this under "Setup environment requirements" - so maybe we can re use some of that content.

Obtaining files

  • Should we rename the branch from "lb" to something more descriptive / general?

@lawrenceabird
Copy link
Contributor Author

Thanks @headmetal!

Yep, I agree with both of these -- I'll add a description to each of the required NCI projects. Updating the branch here is on my radar. I plan to merge this example into main in ACCESS-ISSM before finalising this, so users won't have to specify a branch here.

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

Labels

✏️ documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments