Skip to content

Replace "Note", "Warning", "Caution" etc with admonitions

homotechsual requested to merge github/fork/mickadoo/195-making-admonitions into master

Created by: mickadoo

Closes #195 (closed)

Before

In a number of places we had things like

Note: Blah blah blah

image

After

These will be replaced by admonitions where possible.

image

Notes

In some cases I didn't think it was really worth making an admonition, and just removed the Note: part. These were cases where I felt a simple sentences was more natural.

After running the grep command suggested in the issue there were still some cases found after my changes. However most of these were sentences containing "Note that..". Removing these with

grep -PIr '^(> )?(\*\*)?((Note)|(NOTE)|(Warning)|(WARNING)|(Caution)|(CAUTION)|(Tip)|(TIP)|(Important)|(IMPORTANT)|(NB)|(N\.B\.))' | grep -v "Note that"

This is what remained:

  • docs/common-workflows/tokens-and-mail-merge.md:Tips A "Tips" section (not a single tip)
  • docs/events/creating-an-event.md:Note, depending on your permissions, you may not be able to edit these Just uses "note" in a sentence
  • docs/civic-engagement/set-up.md:**Tips:** A "Tips" section (not a single tip)
  • docs/survey/set-up.md:**Tips:** A "Tips" section (not a single tip)
  • docs/initial-set-up/security.md:Note: ensure passwords used by one person across several protocols are Could be changed, but this file will be deleted anyway

Merge request reports