Skip to content

fixed broken links in getting started section#1205

Merged
WesHarrell merged 1 commit intomainfrom
fix-gettingstarted-links
Mar 25, 2026
Merged

fixed broken links in getting started section#1205
WesHarrell merged 1 commit intomainfrom
fix-gettingstarted-links

Conversation

@WesHarrell
Copy link
Copy Markdown
Collaborator

No description provided.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 25, 2026

Test deployment successful!! (2026-03-25T01:26:42Z)
Preview available at https://callumwalley.github.io/mkdocs-demo-deploy/nesi/support-docs/fix-gettingstarted-links

Seems the following pages differ;



See all deployed demo sites

@WesHarrell WesHarrell merged commit e1fe904 into main Mar 25, 2026
8 checks passed
@WesHarrell WesHarrell deleted the fix-gettingstarted-links branch March 25, 2026 01:27
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

Ahoy there! This here pull request be mostly about mending the navigation charts, or as ye landlubbers call 'em, documentation links. Ye've set a new course for the VSCode guide and pointed the 'Applying for a New Project' scroll to the proper YouTube recordings. However, the wording for that webinar link in the 'Applying for a New Project' document be a bit of a tangled rope, repeating itself like a parrot with a short memory. A true captain would trim that fat for clarity, as the style guide warns against such ambiguous links. And blast me eyes, ye've scuttled a 'See also' note in the System Status document because its link was broken! A seasoned sailor would've fixed the compass to point to the right spot within the same document, rather than throwing it overboard entirely. Ye should add that back, but with a working anchor.

you and your project team gain the necessary skills.
- Become familiar with foundational HPC skills, for example by
watching our introductory webinar, [watching the recorded introductory webinars](../Getting_Help/Introduction_to_computing_on_the_NeSI_HPC.md),
watching our introductory webinar, [watching the recorded introductory webinars](../Getting_Help.md#youtube-recordings),
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

Shiver me timbers! This line be a bit of a tongue-twister, repeating itself like a parrot with a short memory. 'Watching our introductory webinar' and then 'watching the recorded introductory webinars'? A landlubber might get confused. Let's trim the fat and make it clearer for the new recruits.

Suggested change
watching our introductory webinar, [watching the recorded introductory webinars](../Getting_Help.md#youtube-recordings),
watching our [recorded introductory webinars](../Getting_Help.md#youtube-recordings),
References
  1. The style guide (lines 483-499) advises against ambiguous links. While the link itself is fine, the surrounding text is redundant and could be confusing. Simplifying it would improve clarity for the reader. (link)

@@ -4,9 +4,6 @@ tags:
- help
---

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

Blast me eyes! Ye've sent this 'See also' note to Davy Jones' locker. While the old link was as useless as a wooden leg in a swimming race, just scuttling the whole thing makes a soul hunt for the 'Wide area network' section below. Why not just fix the link to point to the right spot in this very document? It'd be a proper treasure map for the reader. Add this back, but with a working link.

Suggested change
!!! note "See also"
[NeSI wide area network connectivity](#wide-area-network)

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant