modernising the mkdoc system on this repo.

[chrisb13]

Hi @atteggiani, I've just moved this mkdoc repository from my personal account onto the community repo'.

I'd now like to

• get it to deploy/build on access-community-hub.github.io/decoding-om3/.
• pr previews working
• rename to Decoding OM3 (a name we landed on with @adele-morrison and others this morning -- details of the plan)
• link checking if possible?

By default, I'd just copy what I think is working here:
https://github.com/ACCESS-Community-Hub/access-iom3-configs/tree/main

e.g. the mkdocs.yml and the github actions etc.

Perhaps you have an up to date set of examples you'd rather I emulate?

[atteggiani]

I think it would make sense to set up this only with RTD, without GitHub pages to avoid having to remove stuff in the near future.

[chrisb13]

Okay, sure thing @atteggiani. Can you share some tips on how to do that? Or feel free to roll it through yourself if that's easier.

[chrisb13]

(I'm chatting about this with @paigem tomorrow afternoon, so would, if possible, be great if I had this part working before then.)

[atteggiani]

Unfortunately I will not have time to set this up properly by tomorrow.
For the moment, I would suggest to set it up like the other config docs.
You can copy the following workflows:

• https://github.com/ACCESS-NRI/ACCESS-Hive-Docs/blob/development/.github/workflows/check_links.yml
• https://github.com/ACCESS-NRI/ACCESS-Hive-Docs/blob/development/.github/workflows/deploy_to_github_pages.yml
• https://github.com/ACCESS-NRI/ACCESS-Hive-Docs/blob/development/.github/workflows/delete_pr_preview_comment.yml
  and modify them following the instructions at the top.

You'll have to also set up the Pages settings for this repo.

[chrisb13]

Thanks for the suggestions @atteggiani. Completely understand that you're busy.

Unfortunately I will not have time to set this up properly by tomorrow.

Actually, it seems (surprising!) it's rendering/building here:
https://access-community-hub.github.io/decoding-om3/

So I can possibly get away with that less-than-ideal option for tomorrow. As in, would rather wait and go the RTD route if practical -- we'll see.

(You're welcome to the meeting with @paigem if you'd like some more background -- no pressure though)