Skip to content

Describe how to add comments in the style guide

Adam Cohen requested to merge document-how-to-add-comments into master

What does this MR do?

This MR adds details to the Style Guide section to explain how to add comments to our documentation.

Screenshots or Screencasts (strongly suggested)

image

How to setup and validate locally (strongly suggested)

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Adam Cohen

Merge request reports