Skip to content

Make it clear that examples do not always reflect the default settings

Gabriel Yoachum requested to merge docs-master-patch-f3c2 into master

What does this MR do?

This just adds a note on the page calling out that the examples provided in the gitlab.rb do not always reflect the default settings for an instance. For example:

https://docs.gitlab.com/omnibus/settings/configuration.html#disable-the-varoptgitlab-directory-management

This value, once uncommented is not the default:

manage_storage_directories['enable'] = false

But we have it in our gitlab.rb as a commented out value, when the default value is actually true.

The point in this is to have a sentence in our docs that confirms that not all examples provided in the template are default, which some support engineers may not even be aware of. I know I and others were not aware of this until right before I made this MR.

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.
Edited by Gabriel Yoachum

Merge request reports