Added Broken Link Check Action

[ahmadabdalla]

Change

• Added a new Broken Link Checker - Lychee
  • Validates all URLs inside the repository
  • Runs on a Pull request against main for anything *md, also supports workflow_dispatch so it can be checked in a branch.
  • Created an exclusion file .lycheeignore and added a lot of the URLs that either don't resolve or has authorization to it.
• Added feature to the Set-ModuleReadMe.ps1 utility to validate a generated template reference URL if it is broken or not
  • Checks the generated URL (with API version), if it works, then that is used. If not
  • It checks the same URL but removes the specific API version so we can use the latest published, if it works then that is used. If not
  • Checks if the resource is a child, if yes then use the Parent as reference using the latest API available. If not
  • Take the basic URL for Bicep and Templates documentation
  • We will always aim to have a valid URL in there, hence all broken URLs are now fixed by using the action we introduced.
• Other:
  • Aligned all fake email addresses and URLs so that we can apply a consistent exclusion.
  • There were other paths inside the wiki that started with .\ changed to ./ to align with the rest

Testing:

• This has been tested in the fork using a branch that attempts to merge to main with a broken URL, or no broken URLs.

Example:

Feel free to remove this sample text

Thank you for your contribution !
Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context.
List any dependencies that are required for this change.

Type of Change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)

Checklist

• I'm sure there are no other open Pull Requests for the same update/change
• My corresponding pipelines / checks run clean and green without any errors or warnings
• My code follows the style guidelines of this project
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation (readme)
• I did format my code