search

Azure / azure-cli-dev-tools

Developer utilities for Azure CLI command module and extension developers.
MIT License
81 stars 113 forks source link

add html tag and broken link detection in linter #483

Closed AllyW closed 1 week ago

AllyW commented 1 month ago

referring to these two rules from learn doc:

  1. disallowed html tag: https://review.learn.microsoft.com/en-us/help/platform/validation-ref/disallowed-html-attribute?branch=main
  2. broken site link: https://review.learn.microsoft.com/en-us/help/platform/validation-ref/other-site-link-broken?branch=main

It's better to have doc checker deployed here but is backloged now for doc builder team. If ready, we can remove these two rules in our repo.

Step 1: set severity=Medium to unblock CI Step 2： mitigate current disallowed html tags Step 3: set severity=High to block any future issues

Besides that, cause cli does not have the knowledge of whether the link is broken or just a placeholder, therefore, the detection on broken link is by module and would require the service owner to fix them

azure-client-tools-bot-prd[bot] commented 1 month ago

Hi @AllyW, Please write the description of change into HISTORY.rst. If you want to release a new azdev version, please update the VERSION in init.py as well.