Skip to content

Doc: Update environment variables page with styling

Craig Norris requested to merge docs-update-style-env-var into master

What does this MR do?

This MR attempts to put in some recent style updates into the Environment variables page, in an attempt to make our way through the docset to make improvements. This MR doesn't change any of the functional meaning of its content, but implemented Style Guide rules, such as table styling, avoiding latin phrases, capitalization rules, and others.

If you have any questions or comments, let me know. If anything needs to be fixed (or if I missed anything), feel free to make the change, but note that this is a quick effort to get the page into a more modern content style, and not to fix functional content issues in the page (if any exist) or to add missing information.

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.

For more information about labels, see Technical Writing workflows - Labels.

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

Loading