HTML comments in documentation markdown files
Problem to solve
While working on !121794 (merged), which would bring a newer version of Markdownlint
, I noticed a lot of false positives that ended up being a bug with the new version: https://github.com/DavidAnson/markdownlint/issues/832.
One thing this bug showed, though, is quite a lot of documentation files have commented out Markdown, often in the form of TODOs that haven't been actioned.
Further details
These files were picked up:
-
doc/development/fe_guide/security.md
-
doc/development/testing_guide/end_to_end/capybara_to_chemlab_migration_guide.md
-
doc/operations/incident_management/slack.md
!122790 (merged)- https://gitlab.com/gitlab-org/gitlab/-/blob/7d014b70a559f8e2e79ffea11f8c2a339c401b86/doc/operations/incident_management/slack.md#L22-23
- https://gitlab.com/gitlab-org/gitlab/-/blob/7d014b70a559f8e2e79ffea11f8c2a339c401b86/doc/operations/incident_management/slack.md#L47-57
- https://gitlab.com/gitlab-org/gitlab/-/blob/7d014b70a559f8e2e79ffea11f8c2a339c401b86/doc/operations/incident_management/slack.md#L97-113
- grouprespond
-
doc/user/application_security/api_fuzzing/index.md
Proposal and who can address
Technical writers can check with the original author of the comments, then remove the commented content and, if necessary, move the details into an issue.
Edited by Amy Qualls