Hyperlink Linter Improvements Tracker

[patrick-5546]

Purpose

Track all issues related to improving the hyperlink linter in one place

To Do

• Adding Configuration File for Hyperlink Linter #88
• Add type hinting to markdown redirection linter #107
• External link to site used instead of internal link; for example if we are in docs/:

  [homepage](https://ubcsailbot.github.io/docs/index.md) -> [homepage](./index.md)
  

• Internal link opens in new tab instead of in the same tab

  [homepage](./index.md){target=_blank} -> [homepage](./index.md)
  

  • This could be configurable
• Publish in its own repo
• Support new format: Update Sailbot Workspace and ROS pages #129 (comment)
• No bare URLs

Notes

• If you want to test the linter locally, copy the lint_links.py file to the root directory of the project and run it there. Remember to not commit the file in the root directory and put all your final changes in the file in the actions folder!
• You will need to be familiar with regular expressions to develop this linter. Refer to the resources below.
• You will be interested in the follow for these issues:
  • These files
  • The following lines in lint.yml:
    

    docs/.github/workflows/lint.yml

    Lines 38 to 52 in ce44c57

    	markdown-link-redirection-check:
    	runs-on: ubuntu-latest
    	steps:
    	- name: Check out code
    	uses: actions/checkout@v2
    	- uses: actions/checkout@v3
    	- name: Set up Python 3.10
    	uses: actions/setup-python@v2
    	with:
    	python-version: "3.10"
    	- name: Check links to external sites redirect to a new tab
    	uses: ./.github/actions/lint/

Resources

• GitHub Action for Linting Hyperlink Redirection #86
• Learn Regex
• Test Regex -- Use the "Python" flavor and not the default PHP flavor.
• Understand GitHub Actions