Skip to content

Docs: Edited for style and to clarify how the variables work

Suzanne Selhorn requested to merge patch-232-selhorn into master

What does this MR do?

As I was reading this topic, I came across a statement I didn't understand:

The `MYSQL_DATABASE` and `MYSQL_ROOT_PASSWORD` variables can't be set in the GitLab UI.
To set them, assign them to a variable [in the UI](../variables/README.md#via-the-ui), 
and then assign that variable to the 
`MYSQL_DATABASE` and `MYSQL_ROOT_PASSWORD` variables in your `.gitlab-ci.yml`.

I dug into the issue with @marcel.amirault and tested in a test project to confirm the functionality, then re-wrote that bit and updated the example to be more clear.

While I was looking at the topic, I edited it for style and clarity.

Related issues

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 Suzanne Selhorn

Merge request reports

Loading