Skip to content

Updates to GitGuardian documentation

What does this MR do?

The intent of this MR is to update the GitGuardian documentation to reflect the latest status of the feature:

  • Remove SaaS from the offering list, because the feature is only available for Self-Managed and Dedicated.
  • Remove the beta status, because the feature is ready for production use and no additional work is planned for it.
  • Modify the feature flag notification, because the feature flag is on by default.
  • Provide a more specific warning regarding how this integration could affect push times and/or cause timeouts where pushes aren’t processed if too many pushes are sent at the same time.

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 Marie-Christine Babin

Merge request reports