Docs: upgrade (broken) Ruby example

What does this MR do?

This MR upgrades the (broken) Ruby example in the docs.

Here is a list of changes from the original example:

  • Remove quotes around image
  • Move global parameters to default: (some global parameters are deprecated)
  • Remove sudo
    • By default on Docker / GitLab.com, the job runs with root permissions
    • sudo binary also needs to be installed separately (not included with image)
    • Note: effectively reverts !39012 (merged)
  • Split apt-get update and apt-get install (helps with debugging)
  • Remove -qq (a flag to be extra quiet). Also helps with debugging
  • Replace double consecutive space with single space

Demo pipelines: before (failing) and after (passing)

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.
    • Ensure docs metadata are present and up-to-date.
    • Ensure Technical Writing and documentation are added.
    • Add the corresponding docs:: scoped label.
    • Add twdoing when starting work on the MR.
    • Add twfinished if Technical Writing team work on the MR is complete but it remains open.

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 Jonston Chan

Merge request reports

Loading
Loading