Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Changed entire website to Markdown + new link checker #679

Merged
merged 20 commits into from
May 10, 2024
Merged

Changed entire website to Markdown + new link checker #679

merged 20 commits into from
May 10, 2024

Conversation

atteggiani
Copy link
Contributor

@atteggiani atteggiani commented May 2, 2024 •
edited
Loading

This is another very big PR, where the following changes have been made:

  • All syntax changed to Markdown (where possible)
    Some exceptions are cards, references (more on this below), simulated terminals, content tabs (for example the one used for different versions of ACCESS-OM2).
    The files related to Model Evaluation (inside docs/model_evaluation and docs/community_resources/community_med were not changed as the syntax of those files will be changed within the extensive MED restructure.

  • New link checker
    lychee (more specifically its GitHub action lychee-action) is now used for link checking.
    It checks for broken URLs of links and images both with Markdown and HTML syntax.
    In the README there is a badge that shows the status of the link checker. Ideally this should always pass. Now it is failing because there are still the MED links to check (as mentioned above).

  • All internal URLs changed to ABSOLUTE URLs
    All internal URLs (links and images) changed to absolute URLs.
    Internal URLs need to be ABSOLUTE URLs, starting with / which indicates the base website https://access-hive.org.au/ (http://localhost:8000/ when deploying with mkdocs serve, https://access-hive.org.au/development-website/ for the development website, and https://access-hive.org.au/pr-preview/pr-PRNUM/ for the PR previews).
    So, a reference to the page https://access-hive.org.au/models/configurations/access-cm/ will be /models/configurations/access-cm. Also, all assets need to be linked starting with /assets/....
    This because currently the link checker does not handle relative links properly.

  • Custom tags
    To facilitate the rendering of recurring components, custom tags have been created (in the js/custom-tags.js file).
    Currently, the available custom tags are:

    • "NOT directly supported by ACCESS-NRI" admonition
      The <custom-not-supported/> tag renders a preset "NOT directly supported by ACCESS-NRI" admonition (example for community MED page).

    • References
      The <custom-references> ... </custom-references> tag renders references to be used at the bottom of a page. Each new line (created by pressing return/Enter) inside ... is rendered as a separate bullet point. A hyphen (-) can included at the beginning of a new line (for clarity) but it is stripped off at the time of rendering (example for How to run ACCESS-CM2 page)..

    • Simulated terminal info
      The <custom-simulated-terminal-info/> tag renders a preset info admonition on the pages where simulated terminal are used.
      It should not be used manually as it is automatically added in the pages containing simulated terminals.

  • README updated
    Updated the guidelines for developers in the README.

  • Other minor modifications

I understand the number of changed files is massive, but in most files content does not change much (only syntax).
What I suggest for the review, apart from looking at the changes themselves, is to compare the PR-preview website to the Development website. Most pages should be exactly the same despite the changes in the syntax.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 2, 2024 •
edited
Loading

PR preview
⚠️ There was an error in the pr-preview deployment. For more information, please check the Actions tab.
2024-05-10 14:27 AEST

@atteggiani atteggiani mentioned this pull request May 2, 2024
Closed
3 tasks
heidinett
heidinett reviewed May 2, 2024
View reviewed changes
docs/about/contact.md Outdated Show resolved Hide resolved
heidinett
heidinett reviewed May 2, 2024
View reviewed changes
docs/getting_started/are.md
Multiple environment variables are separated by a comma (_,_).

- **Jobfs size**<br>
The maximum amount of local disk available to the session.<br>
Copy link
Contributor

Choose a reason for hiding this comment

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

Edit: replace "to the session" with "for the session"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That is the original jobfs description on the ARE website

heidinett
heidinett reviewed May 2, 2024
View reviewed changes
docs/getting_started/are.md
You can delete a session before its automatic expiration (based on the specified [Walltime](#walltime-option) by clicking on the session's ![Session Delete button](/assets/session_delete_button.png){: style="height:1em"} button in the [Interactive Sessions](https://are.nci.org.au/pun/sys/dashboard/batch_connect/sessions) page.
Copy link
Contributor

Choose a reason for hiding this comment

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

Edit: replace 'before its automatic expiration...' with "before it automatically expires..."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I prefer its automatic expiration here. Is there any particular reason why you make your suggestion?

heidinett
heidinett reviewed May 2, 2024
View reviewed changes
docs/tutorials/ilamb.md Outdated Show resolved Hide resolved
heidinett
heidinett reviewed May 2, 2024
View reviewed changes
docs/tutorials/intake.md Outdated Show resolved Hide resolved
@atteggiani
Copy link
Contributor Author

Thanks for the speedy and review @heidinett!

@atteggiani atteggiani mentioned this pull request May 6, 2024
Merged
@atteggiani
Testing link checker action
b842f17 
Fixed lychee config file path

test

testing link checker

testing link checker

testing link checker

testing link checker

testing link checker

testing link checker

testing link checker

testing link checker

testing link checker

testing link checker
@atteggiani
Changed markdown + links in /docs/contribute
618b55f
@atteggiani
Changed markdown + links in /docs/user_support
6f6ff70
@atteggiani
Changed markdown + links in /docs/about
fc592b9
@atteggiani
Changed markdown + links in /docs/community_resources, with exception…
d004051 
… of the 'community_med' folder as will be reviewed later with the MED review
@atteggiani
Changed markdown + links in /docs/getting_started. Created custom-ref…
4341b6b 
…erences tag to render references.
@atteggiani
Changed markdown + links in /docs/tutorials.
259fc78
@atteggiani
Changed markdown + links in /docs/models/configurations
1e1237e
@atteggiani
Changed markdown + links in /docs/models/run-a-model/run-access-esm. …
2eed73d 
…Created custom HTML tag for the simulated terminal info admonition
@atteggiani
Changed markdown + links in /docs/models/run-a-model/run-access-cm.
ccdbae2
@atteggiani
Fixed issues with some links (with exception of docs/model_evaluation…
7018f38 
… and docs/community_resources/community_med folders
@atteggiani
Added link checker badge in README
9fed9a4
@atteggiani
Renamed link check workflow
308f14e
@atteggiani
Deleted useless file
6925445
@atteggiani
Added linkedin to excluded URLs
fd9297e
@atteggiani
Updated README
bd9bbca 
Fix link to section in README

Updated README

Updated README

Updated README

Updated README

Updated README

Updated README

Updated README

Updated README
@atteggiani
Updated custom tags. Added function to automatically add simulation t…
227d97e 
…erminal info admonitions to pages with simulated terminals. Updated REAMDE

Minor edit to custom-not-supported tag
@atteggiani
Updated README
d69be88 
Updated README

adding reviews
@atteggiani
Adding Heidi's reviews
5b044ce 
Adding Heidi's reviews

Updating branch with latest updates from old branch
@atteggiani
Copy link
Contributor Author

Thanks a lot @heidinett, @flicj191 and @KAUR1984 for the reviews!
Merging this :)

@atteggiani atteggiani closed this May 10, 2024
@atteggiani atteggiani reopened this May 10, 2024
@atteggiani atteggiani merged commit 9358494 into development May 10, 2024
14 of 18 checks passed
@atteggiani atteggiani deleted the davide/link_checker branch May 10, 2024 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@heidinett heidinett heidinett approved these changes

@flicj191 flicj191 flicj191 approved these changes

@KAUR1984 KAUR1984 KAUR1984 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@atteggiani @flicj191 @KAUR1984 @heidinett