Skip to content

Standardize code block naming to shell

Marcel Amirault requested to merge docs-code-block-naming into master

What does this MR do?

Do two find and replaces to change sh and bash code blocks to shell:

  • grep -rl '\`\`\`bash$' . | xargs sed -i '' -e 's/\`\`\`bash/\`\`\`shell/g'
  • grep -rl '\`\`\`sh$' . | xargs sed -i '' -e 's/\`\`\`sh$/\`\`\`shell/g'

Related issues

Related to #32881 (closed)

Author's checklist

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.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading