search

ACCESS-NRI / access-hive.org.au

Documentation hub for the Earth System models, ACCESS, and their community
https://access-hive.org.au/
8 stars 11 forks source link

fix links to pass check_links #826

Open atteggiani opened 3 weeks ago

atteggiani commented 3 weeks ago

Fix the links urls in the MED section (and a few other sections) to pass check_links action.

Requirements:

Two practical examples:

Wrong link --> link doesn't work

The reference link is the first link in https://access-hive.org.au/tutorials/ilamb:

https://github.com/ACCESS-NRI/access-hive.org.au/blob/51278bfab8b1ec07dcfb752428ff9cbba7b89c8d/docs/tutorials/ilamb.md?plain=1#L3

This link points to /model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_ilamb. This means there should be a page at https://access-hive.org.au/model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_ilamb, but if you click on this link it gives you a 404 error (page doesn't exist). The link should be instead /model_evaluation/evaluation_on_gadi/ilamb_workflow/, pointing to https://access-hive.org.au/model_evaluation/evaluation_on_gadi/ilamb_workflow/

Internal relative link (and also index.md file in it) --> link works but is falsely failed by the link_checker

The reference link is in https://access-hive.org.au/community_resources/community_med/community_med_recipes:

https://github.com/ACCESS-NRI/access-hive.org.au/blob/51278bfab8b1ec07dcfb752428ff9cbba7b89c8d/docs/community_resources/community_med/community_med_recipes.md?plain=1#L4

The link is ../../model_evaluation/index.md (note the ../../ at the beginning and the index.md at the end). In this case the change is easier:

  1. Go to the linked page (if it works, otherwise refer to the example above)
  2. Copy the part after the base website
  3. Paste that as the new link

In the case above, the new link should be /model_evaluation.

Tasks to fix the issue

atteggiani commented 2 weeks ago

@flicj191 Added more specification on this. To trigger the check_links action you only need to open a PR (also as a draft for testing while the links are changed).

pboubel commented 1 week ago

The ACCESS-NRI Intake Catalog section in the tutorials has a broken link but there is not yet a corresponding section in 'Model Evaluation'. Do we just want to link this to the Intake Catalog docs? (https://access-nri-intake-catalog.readthedocs.io/en/latest/index.html)

atteggiani commented 1 week ago

The ACCESS-NRI Intake Catalog section in the tutorials has a broken link but there is not yet a corresponding section in 'Model Evaluation'. Do we just want to link this to the Intake Catalog docs? (https://access-nri-intake-catalog.readthedocs.io/en/latest/index.html)

Hi @pboubel, can you please point to the page in the Hive Docs where there is the broken link?

pboubel commented 1 week ago

The ACCESS-NRI Intake Catalog section in the tutorials has a broken link but there is not yet a corresponding section in 'Model Evaluation'. Do we just want to link this to the Intake Catalog docs? (https://access-nri-intake-catalog.readthedocs.io/en/latest/index.html)

Hi @pboubel, can you please point to the page in the Hive Docs where there is the broken link?

yes, here: https://access-hive.org.au/tutorials/intake/

pboubel commented 1 week ago

Also, there is a link to the 'recipe gallery' here https://access-hive.org.au/community_resources/community_med/community_med_recipes/ Doesn't seem to exist anywhere that I have looked

flicj191 commented 1 week ago

hi @pboubel, the link in the intake tutorials page is supposed to point to here: https://access-hive.org.au/model_evaluation/data/model_catalogs/ the page was renamed to cover model data more broadly for the MED restructure before going into access-nri intake

you can leave the one in the community resources section, it was done a while ago and may need to look into the history, there's a separate issue to review it and organise so we will come to that with that issue #827 and #831

thanks for looking at this!

atteggiani commented 1 week ago

you can leave the one in the community resources section, it was done a while ago and may need to look into the history, there's a separate issue to review it and organise so we will come to that with that issue #827 and #831

Even though we are going to properly address the community resources section in the issues linked, after this issue is fixed the link checker should pass. Therefore, for the moment, I would say to simply remove the sentence: "We are trying to ingest more and more model evaluation and diagnostics recipes in your currated recipe gallery on this website." in that page.

Thank you @pboubel!

pboubel commented 1 week ago

@atteggiani So I have a few remaining cases that are failing check_links that I'm not sure how to deal with (see this run: https://github.com/ACCESS-NRI/access-hive.org.au/actions/runs/11545655642):

[ERR] %intel@19.0.3.199 | Failed: Unreachable mail address: %intel@19.0.3.199: Invalid: Email doesn't exist or is syntactically incorrect

check_links is mistaking this bit of text in the terminal window for an email it needs to check

atteggiani commented 1 week ago
  • Internal links that point to images or .md files (and one external link) that no longer exist, but the text/code that references these links has been commented out E.g. all the commented-out html code in docs/model_evaluation/evaluation_on_gadi/esmvaltool_workflow.md

Please just delete all the commented out text generating issues with links.

I am not sure where those links wanted to point to. Do you have any idea @flicj191?

That link has been removed because the UM partneship has been "superseeded" by the Momentum partneship for the next generation models.

I would substitute the link with the following link to a document about the UM partneship: https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/research/foundation-science/um_partnership_handout.pdf

  • This error:

[ERR] %intel@19.0.3.199 | Failed: Unreachable mail address: %intel@19.0.3.199: Invalid: Email doesn't exist or is syntactically incorrect

check_links is mistaking this bit of text in the terminal window for an email it needs to check

This needs to be excluded from the check. It can be done by adding the following line:

'^%intel@',

to the exclude field of the lychee-config.toml:

https://github.com/ACCESS-NRI/access-hive.org.au/blob/612f26b39cab6e2135263f98cdca3e2d8865f075/.github/workflows/lychee-config.toml#L4-L9