Skip to content

Clarify precedence note for remote configuration

Manuel Grabowski requested to merge docs/mg-clarify-precedence-20230817 into master

What does this MR do?

The current wording Loading local project configuration isn't used anywhere else on the page, making it hard to understand what it actually refers to. In fact, I'm not 100% sure myself if this change is correct or not.

I found values at the end a bit confusing as well. It's just one value – the external reference, isn't it?


This change is motivated by a customer reporting this feature to not be working as expected in 🎫 #439828 (internal) and me not being quite sure about how it is supposed to work based on these docs.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

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

Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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.
    • Ensure a release milestone is set.
    • 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 reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Manuel Grabowski

Merge request reports

Loading