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.

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

Fix typo and add references on the 'Introduction to networking' page #121

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

network-charles
Copy link

@network-charles network-charles commented Jan 21, 2025

This PR resolves a spelling mistake on the "Introduction to networking" page.

"syncronises" should be "synchronises"

Relevant to canonical/open-documentation-academy#162

@network-charles network-charles marked this pull request as draft January 21, 2025 17:56
@network-charles network-charles force-pushed the network-charles-patch-1 branch from d7bb4cd to 122978a Compare January 21, 2025 18:25
@network-charles network-charles marked this pull request as ready for review January 21, 2025 18:26
@network-charles network-charles changed the title Fix Typo and Add References on the 'Introduction to networking' Page Fix typo and add references on the 'Introduction to networking' page Jan 21, 2025
Copy link
Collaborator

@s-makin s-makin left a comment

Choose a reason for hiding this comment

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

Hi @network-charles, thank you for taking the time to submit this PR.

Because we use MyST-flavoured markdown, we are able to use the {ref}text <link> format to render internal documentation links. This is an advantage over the standard markdown approach of hard-coding links because if a page gets moved, the link does not get broken or need to be updated.

Could I ask you to please revert the changes you made to the link formatting as we don't want to include any hard-coded internal links (they are harder to maintain).

Thanks in advance!

@network-charles network-charles force-pushed the network-charles-patch-1 branch from 122978a to 929efbb Compare January 22, 2025 12:18
@network-charles
Copy link
Author

Thanks for the feedback, @s-makin. I will get familiar with MyST-flavoured markdown. Is it something like this?

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.

2 participants