Skip to content

Consistent use of $ in codeblocks

Achilleas Pipinellis requested to merge docs-dollar-sign-codeblocks into master

What does this MR do?

Use consistent format while specifying shell commands in docs.

Based on the docs guidelines https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#code-blocks

When providing a shell command and its output, prefix the shell command with $ and leave a blank line between the command and the output.

This MR applies that rule and fixes some occurrences where $ shouldn't exist.

Related issues

Closes gitlab-org/distribution/team-tasks#203 (closed).

Author's checklist (required)

Do not add the ~"feature", frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

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

  • 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