Skip to content

Create an ACCESS Hive technical docs template repo #945

Open
@chrisb13

Description

@chrisb13

Discussed with @heidinett this morning. So opening an issue here.

Off the back of the work related to this issue, we now have some OM3 configuration docs! Here: https://access-om3-configs.access-hive.org.au/

As mentioned here, there is still the related problem of creating some "model docs" for WOMBAT (@pearseb @dougiesquire), this will use mkdocs too but be more of a technical model description rather than specific configuration details. And possibly other configuration like doc's for things like CM3, ESM1.6, rOM3 etc (@blimlim @helenmacdonald @jemmajeffree @kieranricardo @MartinDix).

These docs (by default) would not require the stubs feature implemented here, so are simpler to build/deploy.

To make this process simpler for ACCESS-NRI staff/community people, I think a template repository would really help. Examples. Would that be possible @atteggiani? @bschroeter perhaps will have suggestions on how/where it's deployed?

@dougiesquire suggested one solution could be it's own template repo where it could be a submodule in this repo but open to other ideas (this means it's not just limited to being for configs).

ping @KAUR1984 @paigem for ideas too!

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions