Skip to content

Docs: Changing badges to use parentheses not brackets

Marcel Amirault requested to merge docs-brackets-to-parens into master

What does this MR do?

The docs site was updated to allow parentheses in badges, and this MR updates all badges to reflect this. The effect is to reduce the huge number of markdown warnings that the Kramdown renderer would throw because it thought the badges were links without URLs (due to using square brackets).

Find and replace used (I did each badge manually, to make sure there was no collateral damage):

find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[FREE ONLY\]\*\*/\*\*\(FREE ONLY\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[GOLD ONLY\]\*\*/\*\*\(GOLD ONLY\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[SILVER ONLY\]\*\*/\*\*\(SILVER ONLY\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[BRONZE ONLY\]\*\*/\*\*\(BRONZE ONLY\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[ULTIMATE ONLY\]\*\*/\*\*\(ULTIMATE ONLY\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[PREMIUM ONLY\]\*\*/\*\*\(PREMIUM ONLY\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[STARTER ONLY\]\*\*/\*\*\(STARTER ONLY\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[CORE ONLY\]\*\*/\*\*\(CORE ONLY\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[CORE\]\*\*/\*\*\(CORE\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[ULTIMATE\]\*\*/\*\*\(ULTIMATE\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[STARTER\]\*\*/\*\*\(STARTER\)\*\*/g'
find . -name "*.md" | xargs perl -i -p -e 's/\*\*\[PREMIUM\]\*\*/\*\*\(PREMIUM\)\*\*/g'

Related issues

https://gitlab.com/gitlab-org/gitlab-ce/issues/63800
https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/484

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcel Amirault

Merge request reports