Skip to content

GitLab Next

    • GitLab: the DevOps platform
    • Explore GitLab
    • Install GitLab
    • How GitLab compares
    • Get started
    • GitLab docs
    • GitLab Learn
  • Pricing
  • Talk to an expert
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
    • Menu
    Projects Groups Snippets
  • Sign up now
  • Login
  • Sign in / Register
  • GitLab GitLab
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 43,007
    • Issues 43,007
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 1,349
    • Merge requests 1,349
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • GitLab.org
  • GitLabGitLab
  • Merge requests
  • !73116

Bring Sourcegraph feature flag docs to spec

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Amy Qualls requested to merge aqualls-sourcegraph-formatting into master Oct 26, 2021
  • Overview 65
  • Commits 3
  • Pipelines 15
  • Changes 4

What does this MR do?

This MR enables the Sourcegraph feature flag by default and updates the related docs.

Attempts to bring the 1) beta and 2) feature flag statements on https://docs.gitlab.com/ee/integration/sourcegraph.html up to current style guide spec:

  • https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#beta
  • https://docs.gitlab.com/ee/development/documentation/feature_flags.html

Screenshots

Admin - When FF is removed User preferences - When FF is removed User preferences - When FF is enabled for specific actor
admin_ff_removed user_ff_removed user_ff_conditional

Related issues

Author's checklist

  • Consider taking the GitLab Technical Writing Fundamentals course
  • Follow the:
    • Documentation process.
    • Documentation guidelines.
    • Style Guide.
  • Ensure that the product tier badge is added to topic's h1.
  • Request a review based on:
    • The documentation page's metadata.
    • The associated Technical Writer.

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 Jan 18, 2022 by Paul Slaughter
Assignee
Assign to
Reviewer
Request review from
Time tracking
Source branch: aqualls-sourcegraph-formatting