Doc style guide, include options for bullets in Notes (and similar blocks)
Problem to solve
Bullets, in many cases, enhances readability. However, GFM makes it difficult to set up bullets in Alert boxes.
Further details
The standard when setting up bullets is to include blank lines before and after the bullets. When included in a NOTE
, such bullets are found outside of the Alert box:
NOTE: **Note**
Assign a value to at least one of the following variables:
- `gitlab_rails['smartcard_client_certificate_required_host']`
- `gitlab_rails['smartcard_client_certificate_required_port']`
Proposal
Accept and include the "hack" which sets up the Alert box in blocktext, in our style guide.
Example:
> **Notes:**
>
> - Domain verification is **required for GitLab.com users**;
for GitLab self-managed instances, your GitLab administrator has the option
to [disabled custom domain verification](../../../../administration/pages/index.md#custom-domain-verification).
> - [DNS propagation may take some time (up to 24h)](https://www.inmotionhosting.com/support/domain-names/dns-nameserver-changes/domain-names-dns-changes/),
although it's usually a matter of minutes to complete. Until it does, verification
will fail and attempts to visit your domain will respond with a 404.
> - Once your domain has been verified, leave the verification record
in place: your domain will be periodically reverified, and may be
disabled if the record is removed.