Skip to content

Remove outdated mention of restart requirements

Manuel Grabowski requested to merge docs/mg-removerestartwording-20220620 into master

What does this MR do?

Removes wording that is no longer relevant about a restart being required for env var changes to take effect after already doing a reconfigure.

The section was originally added in eed45dce – at that time explicitely specifying gitlab-ctl restart in the snippet as well.

In fafe5097 the gitlab-ctl restart was removed, likely following the completion of the Unicorn->Puma migration, as the wording that was modified then specified different ways for Unicorn- and Puma-based setups. However, only the gitlab-ctl restart command was removed, while the wording that a restart in addition to a reconfigure is required was left behind – this results in a confusing and a bit scary looking section.

I manually confirmed on a test instance that in current versions a reconfigure was enough to get the change picked up.

Related issues

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports