Skip to content

Specify syntax highlighting for shell output

Amy Qualls requested to merge docs-20200123-highlighting into master

What does this MR do?

For the sake of consistency and simplicity, this MR specifies using shell instead of bash or sh for syntax highlighting most shell output, thanks to @eread in !23470 (merged). The exception: code blocks that contain sudo, because @mjang1 discovered in !23466 (merged) it causes oddities in the syntax highlighting output. For code blocks containing sudo, we're now specifying to use console instead.

Related issues

!23466 (merged) !23470 (merged)

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.

Merge request reports