You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Each rule should have a bookmark with its code like "#E405", and we should pe able to right-click in the documentation to copy a link to specific rule --- like we have with sphinx section links where you hover over a head and you can get the ability to get a hyperlink pointing to it.
This is very important UX because we do often need to share references to rules in our discussions chat/email/code-review and we need to be able to reference eact rules.
Also we could even consider printing thes when an error is encountered as the documentaiton should provide explanation for the rule and ways to address it (other than ignoring).
This discussion was converted from issue #471 on December 26, 2020 17:07.
Heading
Bold
Italic
Quote
Code
Link
Numbered list
Unordered list
Task list
Attach files
Mention
Reference
Menu
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Issue Type
Desired Behaviour
Each rule should have a bookmark with its code like "#E405", and we should pe able to right-click in the documentation to copy a link to specific rule --- like we have with sphinx section links where you hover over a head and you can get the ability to get a hyperlink pointing to it.
This is very important UX because we do often need to share references to rules in our discussions chat/email/code-review and we need to be able to reference eact rules.
Also we could even consider printing thes when an error is encountered as the documentaiton should provide explanation for the rule and ways to address it (other than ignoring).
Actual Behaviour (Bug report only)
Currently there is no way to send someone a link to an exact ansible lint rule in documentation because they do not have bookmarks (anchors) on https://docs.ansible.com/ansible-lint/rules/default_rules.html
Beta Was this translation helpful? Give feedback.
All reactions