Links

The links in the handbook should link to the actual .md file rather than an html url.
The Markdown syntax for links is the following:

1
2
3
4
#the display text is in square brackets:
[clickable text]
# and then immediately after that we have the target in round brackets:
(./Links.md)
Here are some examples:
Let say we want to link from this page to the Friday Socials page.
1. The correct way friday socials
1
[friday socials](../../Culture-and-Social/Friday-Socials.md)
2. The incorrect way that will still work but is wrong (DON'T USE THIS)
This is a HTML url friday socials - INCORRECT ON PURPOSE
1
[friday socials - INCORRECT ON PURPOSE](/Culture-and-Social/Friday-Socials)
3. The incorrect way that doesn't work. Using an html link with .md at the end. This will return a 404. friday socials - INCORRECT ON PURPOSE
1
[friday socials - INCORRECT ON PURPOSE](/Culture-and-Social/Friday-Socials.md)

Use the web links when wanting to link to an external page.

Here is one simple example: click here for google

1
[click here for google](https://www.google.com)

In case there are any links that are in the format mentioned above (2. and 3.) they need correcting.
Start by running the following script in the root of the project.

1
$ find ./docs/ -iname "*md" -type f -exec grep  '\[[^]]*\]([^h.#][^)]*)' {} + | grep -v  'mailto:' | grep -v '://' | grep -vi "png\|svg\|gif\|jpg" | grep -v "INCORRECT ON PURPOSE" | sed 's#^\([^:]*\):\(.*\)#[\1](\1) ---  \2#' > filesToCheck.md
This will generate a file in the root of the project called filesToCheck.md. This will contain the potential broken links. Go through the list and make sure all the flagged up links are corrected.

Note

Make sure not to change the ones in this exact file as they are examples