Skip to content

Clarify FF / Unleash relationship

Manuel Grabowski requested to merge docs/mg-clarify-unleash-20231102 into master

What does this MR do?

The current wording suggests a much stronger reliance on Unleash as there is in practice. We're not using the Unleash product directly, we merely implemented a compatible API.

Copying from this Slack thread for clarification:

In the FF docs, we say:

 GitLab uses Unleash, a feature toggle service.

Wouldn’t a sentence like “GitLab offers a Unleash-compatible API” be more accurate? The way this is currently worded makes it sound like we’re somehow bundling the Unleash product, raising the question if and how their pricing is relevant to a GitLab user. I’m 99% certain that it isn’t, but the wording is throwing me off.

Further down:

GitLab feature flags use Unleash as the feature flag engine.

Again, this sounds like we’re making use of something existing, but looking through the MR that added FFs it reads to me that we implemented this completely ourselves. We’re not even using a Gem or anything similar existing from Unleash.

Even further down there is a sentence that does seem to confirm my understanding of how our FF functionality and Unleash are connected:

GitLab implements a single backend that is compatible with Unleash clients.

I’m just wondering if I’m missing something here, otherwise I’ll go ahead and change the wording on the first two quoted sentences. (This is prompted by a customer literally asking me which of the Unleash prices/licenses GitLab is using, so the confusion is not just mine. 😅)

Which was confirmed:

nope you're 100% correct 

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.

Merge request reports