url stringlengths 24 122 | repo_url stringlengths 60 156 | date_extracted stringdate 2025-08-13 00:00:00 2025-08-13 00:00:00 | root stringlengths 3 85 | breadcrumbs listlengths 1 6 | filename stringlengths 6 60 | stage stringclasses 33
values | group stringclasses 81
values | info stringclasses 22
values | title stringlengths 3 110 ⌀ | description stringlengths 11 359 ⌀ | clean_text stringlengths 47 3.32M | rich_text stringlengths 321 3.32M |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
https://docs.gitlab.com/development/fe_guide/lesson_1 | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/lesson_1.md | 2025-08-13 | doc/development/fe_guide/onboarding_course | [
"doc",
"development",
"fe_guide",
"onboarding_course"
] | lesson_1.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Lesson 1 | null |
<div class="video-fallback">
See the video: <a href="https://www.youtube.com/watch?v=k4C3-FKvZyI">Lesson 1 intro</a>.
</div>
<figure class="video-container">
<iframe src="https://www.youtube-nocookie.com/embed/k4C3-FKvZyI" frameborder="0" allowfullscreen> </iframe>
</figure>
In this lesson you tackle the smalles... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Lesson 1
breadcrumbs:
- doc
- development
- fe_guide
- onboarding_course
---
<div cl... |
https://docs.gitlab.com/development/gitlab_instrumentation_for_opentelemetry | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/gitlab_instrumentation_for_opentelemetry.md | 2025-08-13 | doc/development/stage_group_observability | [
"doc",
"development",
"stage_group_observability"
] | gitlab_instrumentation_for_opentelemetry.md | Monitor | Platform Insights | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab instrumentation for OpenTelemetry | null |
## Enable OpenTelemetry tracing, metrics, and logs in GDK development
{{< alert type="note" >}}
Currently the default GDK environment is not set up by default to properly
collect and display OpenTelemetry data. Therefore, you should point the
`OTEL_EXPORTER_*_ENDPOINT` ENV vars to a GitLab project:
{{< /alert >}}
... | ---
stage: Monitor
group: Platform Insights
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab instrumentation for OpenTelemetry
breadcrumbs:
- doc
- development
- ... |
https://docs.gitlab.com/development/stage_group_observability | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/stage_group_observability | [
"doc",
"development",
"stage_group_observability"
] | _index.md | Platforms | Scalability | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Observability for stage groups | null |
Observability is about bringing visibility into a system to see and
understand the state of each component, with context, to support
performance tuning and debugging. To run a SaaS platform at scale, a
rich and detailed observability platform is needed.
To make information available to [stage groups](https://handboo... | ---
stage: Platforms
group: Scalability
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Observability for stage groups
breadcrumbs:
- doc
- development
- stage_group_ob... |
https://docs.gitlab.com/development/stage_group_observability/error_budget_detail | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/stage_group_observability/error_budget_detail.md | 2025-08-13 | doc/development/stage_group_observability/dashboards | [
"doc",
"development",
"stage_group_observability",
"dashboards"
] | error_budget_detail.md | Platforms | Scalability | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Error budget detail dashboard | null |
With error budget detailed dashboards you can explore the error budget
spent at specific moments in time. By default, the dashboard shows
the past 28 days. You can adjust it with the [time range controls](_index.md#time-range-controls)
or by selecting a range on one of the graphs.
This dashboard is the same kind of ... | ---
stage: Platforms
group: Scalability
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Error budget detail dashboard
breadcrumbs:
- doc
- development
- stage_group_obs... |
https://docs.gitlab.com/development/stage_group_observability/stage_group_dashboard | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/stage_group_observability/stage_group_dashboard.md | 2025-08-13 | doc/development/stage_group_observability/dashboards | [
"doc",
"development",
"stage_group_observability",
"dashboards"
] | stage_group_dashboard.md | Platforms | Scalability | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Stage group dashboard | null |
The stage group dashboard is generated dashboard that contains metrics
for common components used by most stage groups. The dashboard is
fully customizable and owned by the stage groups.
This page explains what is on these dashboards, how to use their
contents, and how they can be customized.
## Dashboard contents
... | ---
stage: Platforms
group: Scalability
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Stage group dashboard
breadcrumbs:
- doc
- development
- stage_group_observabili... |
https://docs.gitlab.com/development/stage_group_observability/dashboards | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/stage_group_observability/_index.md | 2025-08-13 | doc/development/stage_group_observability/dashboards | [
"doc",
"development",
"stage_group_observability",
"dashboards"
] | _index.md | Platforms | Scalability | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Dashboards for stage groups | null |
We generate a lot of dashboards acting as windows to the metrics we
use to monitor GitLab.com. Most of our dashboards are generated from
Jsonnet in the
[runbooks repository](https://gitlab.com/gitlab-com/runbooks/-/tree/master/dashboards#dashboard-source).
Anyone can contribute to these, adding new dashboards or modi... | ---
stage: Platforms
group: Scalability
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Dashboards for stage groups
breadcrumbs:
- doc
- development
- stage_group_obser... |
https://docs.gitlab.com/development/metadata | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/metadata.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | metadata.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Metadata | null |
Each documentation Markdown page contains YAML front matter.
All values in the metadata are treated as strings and are used for the
documentation website only.
## Stage and group metadata
Each page should have metadata related to the stage and group it
belongs to, an information block, and the page title. For examp... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Metadata
breadcrumbs:
- doc
- development
- documentation
---
Each documentation Markdown page contains YAML fron... |
https://docs.gitlab.com/development/redirects | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/redirects.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | redirects.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Redirects in GitLab documentation | Learn how to contribute to GitLab Documentation. |
When you move, rename, or delete a page, you must add a redirect. Redirects reduce
how often users get 404s when they visit the documentation site from out-of-date links.
Add a redirect to ensure:
- Users see the new page and can update or delete their bookmark.
- External sites can update their links, especially s... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Learn how to contribute to GitLab Documentation.
title: Redirects in GitLab documentation
bread... |
https://docs.gitlab.com/development/authoring_environment | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/authoring_environment.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | authoring_environment.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Set up your authoring environment | null |
Set up your environment for writing and previewing GitLab documentation.
You can use whichever tools you're most comfortable with.
Use this guidance to help ensure you have the tools you need.
- Install a code editor, like VS Code or Sublime Text, to work with Markdown files.
- [Install Git](../../topics/git/how_to... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Set up your authoring environment
breadcrumbs:
- doc
- development
- documentation
---
Set up your ... |
https://docs.gitlab.com/development/review_apps | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/review_apps.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | review_apps.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Documentation review apps | Learn how documentation review apps work. |
GitLab team members can deploy a [review app](../../ci/review_apps/_index.md) for merge requests with documentation
changes. The review app lets you preview how your changes appear on the [GitLab Docs site](https://docs.gitlab.com) before merging.
Review app deployments are available for these projects:
| Project ... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Learn how documentation review apps work.
title: Documentation review apps
breadcrumbs:
- doc
-... |
https://docs.gitlab.com/development/documentation | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | _index.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Contribute to the GitLab documentation | Documentation style guide and workflows. |
The GitLab documentation is the single source of truth (SSoT)
for information about how to configure, use, and troubleshoot GitLab.
Everyone is welcome to contribute to the GitLab documentation.
The following instructions are for community contributors.
## Update the documentation
Prerequisites:
- [Request access... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Documentation style guide and workflows.
title: Contribute to the GitLab documentation
breadcru... |
https://docs.gitlab.com/development/workflow | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/workflow.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | workflow.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Documentation workflow | null |
Documentation at GitLab follows a workflow.
The process for creating and maintaining GitLab product documentation depends on whether the documentation is:
- [A new feature or feature enhancement](#documentation-for-a-product-change): Delivered for a specific milestone and associated with specific code changes.
Thi... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Documentation workflow
breadcrumbs:
- doc
- development
- documentation
---
Documentation at GitLab follows a wor... |
https://docs.gitlab.com/development/experiment_beta | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/experiment_beta.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | experiment_beta.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects | Documenting experimental and beta features | null |
When you document an [experiment or beta](../../policy/development_stages_support.md) feature:
- Include the status in the [product availability details](styleguide/availability_details.md#status).
- Include [feature flag details](feature_flags.md) if behind a feature flag.
- [Update the feature status](styleguide/a... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects
title: Documenting experimental and beta features
breadcrumbs:
- doc
- development
- documentation
---
When you document ... |
https://docs.gitlab.com/development/drawers | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/drawers.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | drawers.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Create content for drawers | null |
In the GitLab UI, you can display help content in
[a drawer component](https://design.gitlab.com/components/drawer/).
The component for Markdown is
[in the storybook](https://gitlab-org.gitlab.io/gitlab/storybook/?path=/story/vue-shared-markdown-drawer--default).
The component points to a Markdown file. Any time you... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Create content for drawers
breadcrumbs:
- doc
- development
- documentation
---
In the GitLab UI, y... |
https://docs.gitlab.com/development/hugo_migration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/hugo_migration.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | hugo_migration.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Hugo migration reference for writers | null |
We've rebuilt the GitLab Docs website on Hugo. This guide outlines the formatting
requirements for documentation after the relaunch.
While existing content will be automatically updated, any new or modified documentation must follow these guidelines to ensure proper building with Hugo.
## New project
The new Docs ... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Hugo migration reference for writers
breadcrumbs:
- doc
- development
- documentation
---
We've reb... |
https://docs.gitlab.com/development/backporting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/backporting.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | backporting.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Backport documentation changes | null |
There are two types of backports:
- **Current stable release**: Any maintainer can backport
changes, usually bug fixes but also important documentation changes, into the
current stable release.
- **Older stable releases**: To guarantee the
[maintenance policy](../../policy/maintenance.md) is respected, merging... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Backport documentation changes
breadcrumbs:
- doc
- development
- documentation
---
There are two t... |
https://docs.gitlab.com/development/restful_api_styleguide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/restful_api_styleguide.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | restful_api_styleguide.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Documenting REST API resources | Writing styles, markup, formatting, and other standards for the GitLab RESTful APIs. |
REST API resources are documented in Markdown under
[`/doc/api`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api). Each
resource has its own Markdown file, which is linked from
[`api_resources.md`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/api_resources.md).
When modifying the Markdown or... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Writing styles, markup, formatting, and other standards for the GitLab
RESTful APIs.
title: Documenting RES... |
https://docs.gitlab.com/development/ai_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/ai_guide.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | ai_guide.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Use of AI | null |
Community members can make AI-generated contributions to GitLab documentation, provided they follow the guidelines in our [DCO or our CLA terms](https://about.gitlab.com/community/contribute/dco-cla/).
GitLab team members must follow the guidelines documented in the [internal handbook](https://internal.gitlab.com/ha... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Use of AI
breadcrumbs:
- doc
- development
- documentation
---
Community members can make AI-genera... |
https://docs.gitlab.com/development/graphql_styleguide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/graphql_styleguide.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | graphql_styleguide.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Creating a GraphQL example page | Writing styles, markup, formatting, and other standards for GraphQL API's GitLab Documentation. |
GraphQL APIs are different from [RESTful APIs](restful_api_styleguide.md). Reference
information is generated in our [GraphQL API resources](../../api/graphql/reference/_index.md) page.
However, it's helpful to include examples for how to use GraphQL for different
use cases, with samples that readers can use directl... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: Writing styles, markup, formatting, and other standards for GraphQL API's
GitL... |
https://docs.gitlab.com/development/feature_flags | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/feature_flags.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | feature_flags.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Document features deployed behind feature flags | GitLab development - how to document features deployed behind feature flags |
GitLab uses [feature flags](../feature_flags/_index.md) to roll
out the deployment of its own features.
{{< alert type="note" >}}
The developer who changes the state of a feature flag is responsible for
updating the documentation.
{{< /alert >}}
## When to document features behind a feature flag
Before a feature... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: GitLab development - how to document features deployed behind feature
flags
title: Document features deploy... |
https://docs.gitlab.com/development/help | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/help.md | 2025-08-13 | doc/development/documentation | [
"doc",
"development",
"documentation"
] | help.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | GitLab /help | null |
Every GitLab instance includes documentation at `/help` (`https://gitlab.example.com/help`)
that matches the version of the instance. For example, <https://gitlab.com/help>.
The documentation available online at <https://docs.gitlab.com> is deployed every
hour from the default branch of GitLab, Omnibus, Runner, Char... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: GitLab /help
breadcrumbs:
- doc
- development
- documentation
---
Every GitLab instance includes do... |
https://docs.gitlab.com/development/documentation/availability_details | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/availability_details.md | 2025-08-13 | doc/development/documentation/styleguide | [
"doc",
"development",
"documentation",
"styleguide"
] | availability_details.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Product availability details | Writing styles, markup, formatting, and other standards for GitLab Documentation. |
Product availability details provide information about a feature.
- If the details apply to the whole page, place them at the top
of the page, but after the front matter.
- If they apply to a specific section, place the details under the applicable
section titles.
Availability details include the tier, offering... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Writing styles, markup, formatting, and other standards for GitLab Documentation.
title: Product availability... |
https://docs.gitlab.com/development/documentation/styleguide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/_index.md | 2025-08-13 | doc/development/documentation/styleguide | [
"doc",
"development",
"documentation",
"styleguide"
] | _index.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Documentation Style Guide | Writing styles, markup, formatting, and other standards for GitLab Documentation. |
This document defines the standards for GitLab documentation, including grammar, formatting, and more.
For guidelines on specific words, see [the word list](word_list.md).
## The GitLab voice
The GitLab brand guidelines define the
[voice used by the larger organization](https://design.gitlab.com/brand-messaging/bra... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Writing styles, markup, formatting, and other standards for GitLab Documentation.
title: Documentation Style ... |
https://docs.gitlab.com/development/documentation/word_list | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/word_list.md | 2025-08-13 | doc/development/documentation/styleguide | [
"doc",
"development",
"documentation",
"styleguide"
] | word_list.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Recommended word list | Writing styles, markup, formatting, and other standards for GitLab Documentation. |
To help ensure consistency in the documentation, the Technical Writing team
recommends these word choices. In addition:
- The GitLab handbook contains a list of
[top misused terms](https://handbook.gitlab.com/handbook/communication/top-misused-terms/).
- The documentation [style guide](_index.md#language) includes... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Writing styles, markup, formatting, and other standards for GitLab Documentation.
title: Recomm... |
https://docs.gitlab.com/development/documentation/deprecations_and_removals | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/deprecations_and_removals.md | 2025-08-13 | doc/development/documentation/styleguide | [
"doc",
"development",
"documentation",
"styleguide"
] | deprecations_and_removals.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Deprecations and removals | Guidelines for deprecations and page removals |
When GitLab deprecates or removes a feature, use the following process to update the documentation.
This process requires temporarily changing content to be "deprecated" or "removed" before it's deleted.
If a feature is not generally available, you can delete the content outright instead of following these instructi... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Guidelines for deprecations and page removals
title: Deprecations and removals
breadcrumbs:
- doc
- developme... |
https://docs.gitlab.com/development/documentation/site_architecture | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/_index.md | 2025-08-13 | doc/development/documentation/site_architecture | [
"doc",
"development",
"documentation",
"site_architecture"
] | _index.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Documentation site architecture | null |
The [`docs-gitlab-com`](https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com) project hosts
the repository used to generate the GitLab documentation website and
is deployed to <https://docs.gitlab.com>. It uses the [Hugo](https://gohugo.io/)
static site generator.
For more information, see the [Docs site ... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Documentation site architecture
breadcrumbs:
- doc
- development
- documentation
- site_architecture
---
The [`do... |
https://docs.gitlab.com/development/documentation/folder_structure | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/folder_structure.md | 2025-08-13 | doc/development/documentation/site_architecture | [
"doc",
"development",
"documentation",
"site_architecture"
] | folder_structure.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Folder structure for documentation | null |
The documentation is separated by top-level audience folders [`user`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/user),
[`administration`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/administration),
and [`development`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/development... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Folder structure for documentation
breadcrumbs:
- doc
- development
- documentation
- site_architecture
---
The d... |
https://docs.gitlab.com/development/documentation/global_nav | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/global_nav.md | 2025-08-13 | doc/development/documentation/site_architecture | [
"doc",
"development",
"documentation",
"site_architecture"
] | global_nav.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Global navigation | Learn how GitLab docs' global navigation works and how to add new items. |
Global navigation (global nav) is the left-most pane in the documentation. You can use the
global nav to browse the content.
Research shows that people use Google to search for GitLab product documentation. When they land on a result,
we want them to find topics nearby that are related to the content they're reading... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Learn how GitLab docs' global navigation works and how to add new items.
title: Global navigation
breadcrumbs... |
https://docs.gitlab.com/development/documentation/automation | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/automation.md | 2025-08-13 | doc/development/documentation/site_architecture | [
"doc",
"development",
"documentation",
"site_architecture"
] | automation.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Automated pages | null |
Most pages in the GitLab documentation are written manually in Markdown.
However, some pages are created by automated processes.
Two primary categories of automation exist in the GitLab documentation:
- Content that is generated by using a standard process and structured data (for example, YAML or JSON files).
- Co... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Automated pages
breadcrumbs:
- doc
- development
- documentation
- site_architecture
---
Most pages in the GitLab... |
https://docs.gitlab.com/development/documentation/deployment_process | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/deployment_process.md | 2025-08-13 | doc/development/documentation/site_architecture | [
"doc",
"development",
"documentation",
"site_architecture"
] | deployment_process.md | none | unassigned | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Documentation deployments | null |
## Deployment environments
The [GitLab documentation site](https://docs.gitlab.com/) is a static site hosted by [GitLab Pages](../../../user/project/pages/_index.md).
The deployment is done by the [Pages deploy jobs](#pages-deploy-jobs).
The website hosts documentation only for the [supported](https://about.gitlab.... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Documentation deployments
breadcrumbs:
- doc
- development
- documentation
- site_architecture
---
## Deployment ... |
https://docs.gitlab.com/development/documentation/topic_types | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/_index.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | _index.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Documentation topic types (CTRT) | null |
Each topic on a page should be one of the following topic types:
- [Concept](concept.md)
- [Task](task.md)
- [Reference](reference.md)
- [Troubleshooting](troubleshooting.md)
Even if a page is short, the page usually starts with a concept and then
includes a task or reference topic.
The tech writing team sometimes... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Documentation topic types (CTRT)
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
... |
https://docs.gitlab.com/development/documentation/tutorial | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/tutorial.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | tutorial.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Tutorial page type | null |
A tutorial is page that contains an end-to-end walkthrough of a complex workflow or scenario.
In general, you might consider using a tutorial when:
- The workflow requires sequential steps where each step consists
of sub-steps.
- The steps cover a variety of GitLab features or third-party tools.
## Tutorial guida... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Tutorial page type
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
A tutorial is... |
https://docs.gitlab.com/development/documentation/top_level_page | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/top_level_page.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | top_level_page.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Top-level page type | null |
The top-level page is at the highest level of each section in **Use GitLab** in the global navigation.
This page type:
- Introduces the workflow briefly.
- Lists features in the workflow, in the order they appear in the global navigation.
## Format
The top-level page should be in this format.
```markdown
title: T... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Top-level page type
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
The top-leve... |
https://docs.gitlab.com/development/documentation/get_started | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/get_started.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | get_started.md | none | Style Guide | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Get started page type | null |
A **Get started** page introduces high-level concepts for a broad feature area.
While a specific feature might be defined in the feature documentation,
a **Get started** page gives an introduction to a set of concepts.
The content should help the user understand how multiple features fit together
as part of the large... | ---
stage: none
group: Style Guide
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Get started page type
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
A **Get started** page ... |
https://docs.gitlab.com/development/documentation/glossary | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/glossary.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | glossary.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Glossary topic type | null |
A glossary provides a list of unfamiliar terms and their definitions to help users understand a specific
GitLab feature.
Each glossary item provides a single term and its associated definition. The definition should answer the questions:
- **What** is this?
- **Why** would you use it?
For glossary terms:
- Do not... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Glossary topic type
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
A glossary p... |
https://docs.gitlab.com/development/documentation/concept | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/concept.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | concept.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Concept topic type | null |
A concept introduces a single feature or concept.
A concept should answer the questions:
- **What** is this?
- **Why** would you use it?
Think of everything someone might want to know if they've never heard of this concept before.
Don't tell them **how** to do this thing. Tell them **what it is**.
If you start d... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Concept topic type
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
A concept int... |
https://docs.gitlab.com/development/documentation/troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/troubleshooting.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | troubleshooting.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Troubleshooting topic type | null |
Troubleshooting topics should be the final topics on a page.
If a page has five or more troubleshooting topics, put those topics on a [separate page](#troubleshooting-page-type).
## What type of troubleshooting information to include
Troubleshooting information includes:
- Problem-solving information that might b... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Troubleshooting topic type
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
Troub... |
https://docs.gitlab.com/development/documentation/reference | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/reference.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | reference.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Reference topic type | null |
Reference information should be in an easily-scannable format,
like a table or list. It's similar to a dictionary or encyclopedia entry.
## Format
Reference topics should be in this format:
```markdown
title: Title (a noun, like "Pipeline settings" or "Administrator options")
---
Introductory sentence.
| Setting... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Reference topic type
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
Reference i... |
https://docs.gitlab.com/development/documentation/prompt_example | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/prompt_example.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | prompt_example.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Prompt example page type | null |
A prompt example provides step-by-step instructions for using GitLab Duo to accomplish a specific development or business task.
A prompt example should answer the questions:
- What development challenge does this solve?
- How do you use GitLab Duo to solve it?
These pages should be precise and easy to scan. They d... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Prompt example page type
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
A promp... |
https://docs.gitlab.com/development/documentation/task | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/task.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | task.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Task topic type | null |
A task gives instructions for how to complete a procedure.
## Format
Tasks should be in this format:
```markdown
title: Title (starts with an active verb, like "Create a widget" or "Delete a widget")
---
Do this task when you want to...
Prerequisites (optional):
- Thing 1
- Thing 2
- Thing 3
To do this task:
... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
title: Task topic type
breadcrumbs:
- doc
- development
- documentation
- topic_types
---
A task gives ins... |
https://docs.gitlab.com/development/documentation/version_specific_changes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/version_specific_changes.md | 2025-08-13 | doc/development/documentation/topic_types | [
"doc",
"development",
"documentation",
"topic_types"
] | version_specific_changes.md | none | unassigned | For assistance with this Style Guide page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Version-specific changes | Learn how to document upgrade notes |
A version-specific page contains upgrade notes a GitLab administrator
should follow when upgrading their GitLab Self-Managed instance.
It contains information like:
- Important bugs, bug fixes, and workarounds from one version to another.
- Long-running database migrations administrators should be aware of.
- Break... | ---
stage: none
group: unassigned
info: For assistance with this Style Guide page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Learn how to document upgrade notes
title: Version-specific changes
breadcrumbs:
- doc
- development
- documenta... |
https://docs.gitlab.com/development/documentation/vale | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/vale.md | 2025-08-13 | doc/development/documentation/testing | [
"doc",
"development",
"documentation",
"testing"
] | vale.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Vale documentation tests | Learn how to contribute to GitLab Documentation. |
[Vale](https://vale.sh/) is a grammar, style, and word usage linter for the
English language. Vale's configuration is stored in the [`.vale.ini`](https://vale.sh/docs/topics/config/) file located
in the root directory of projects. For example, the [`.vale.ini`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.vale... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Learn how to contribute to GitLab Documentation.
title: Vale documentation tests
breadcrumbs:
-... |
https://docs.gitlab.com/development/documentation/markdownlint | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/markdownlint.md | 2025-08-13 | doc/development/documentation/testing | [
"doc",
"development",
"documentation",
"testing"
] | markdownlint.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | markdownlint documentation tests | Learn how to contribute to GitLab Documentation. |
[markdownlint](https://github.com/DavidAnson/markdownlint) checks that Markdown syntax follows
[certain rules](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#rules), and is
used by the `docs-lint` test.
Our [Documentation Style Guide](../styleguide/_index.md#markdown) and
[Markdown Guide](https:... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Learn how to contribute to GitLab Documentation.
title: markdownlint documentation tests
breadc... |
https://docs.gitlab.com/development/documentation/testing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/_index.md | 2025-08-13 | doc/development/documentation/testing | [
"doc",
"development",
"documentation",
"testing"
] | _index.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Documentation testing | Learn how to contribute to GitLab Documentation. |
GitLab documentation is stored in projects with code, and treated like code.
To maintain standards and quality of documentation, we use processes similar to
those used for code.
Merge requests containing changes to Markdown (`.md`) files run these CI/CD jobs:
- `docs-lint markdown`: Runs several types of tests, inc... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Learn how to contribute to GitLab Documentation.
title: Documentation testing
breadcrumbs:
- do... |
https://docs.gitlab.com/development/documentation/links | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/documentation/links.md | 2025-08-13 | doc/development/documentation/testing | [
"doc",
"development",
"documentation",
"testing"
] | links.md | none | Documentation Guidelines | For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects. | Documentation and UI link tests | Learn how to contribute to GitLab Documentation. |
For testing:
- Relative links between documentation files, we use [Lychee](https://lychee.cli.rs/installation/).
- Links to documentation from the GitLab UI, we use [`haml-lint`, `eslint`, and `rubocop`](#run-ui-link-tests-locally).
## Run the relative link test locally
To run the relative link test locally, you c... | ---
stage: none
group: Documentation Guidelines
info: For assistance with this Style Guide page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-other-projects-and-subjects.
description: Learn how to contribute to GitLab Documentation.
title: Documentation and UI link tests
breadcr... |
https://docs.gitlab.com/development/cells | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/cells | [
"doc",
"development",
"cells"
] | _index.md | Tenant Scale | Cells Infrastructure | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Cells Development Guidelines | null |
For background of GitLab Cells, refer to the [design document](https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/cells/).
## Available Cells / Organization schemas
Below are available schemas related to Cells and Organizations:
| Schema | Description |
| ------ | ----------- |
| `gitla... | ---
stage: Tenant Scale
group: Cells Infrastructure
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab Cells Development Guidelines
breadcrumbs:
- doc
- development... |
https://docs.gitlab.com/development/configuration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/configuration.md | 2025-08-13 | doc/development/cells | [
"doc",
"development",
"cells"
] | configuration.md | Tenant Scale | Cells Infrastructure | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Configuration | null |
Find the existing cells configuration documentation, under [Cells configuration](../../administration/cells.md).
Add cells-related configuration to `config/gitlab.yml` under the `cell` key.
## References
- [Cells design document](https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/cells/... | ---
stage: Tenant Scale
group: Cells Infrastructure
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Configuration
breadcrumbs:
- doc
- development
- cells
---
Find th... |
https://docs.gitlab.com/development/topology_service | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/topology_service.md | 2025-08-13 | doc/development/cells | [
"doc",
"development",
"cells"
] | topology_service.md | Tenant Scale | Cells Infrastructure | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Topology Service | null |
## Updating the Topology Service Gem
The Topology Service is developed in its [own repository](https://gitlab.com/gitlab-org/cells/topology-service)
We generate the Ruby Gem there, and manually copy the Gem to GitLab vendors folder, in
`vendor/gems/gitlab-topology-service-client`.
To make it easy, you can just run ... | ---
stage: Tenant Scale
group: Cells Infrastructure
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Topology Service
breadcrumbs:
- doc
- development
- cells
---
## U... |
https://docs.gitlab.com/development/application_settings_analysis | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/application_settings_analysis.md | 2025-08-13 | doc/development/cells | [
"doc",
"development",
"cells"
] | application_settings_analysis.md | Tenant Scale | Cells Infrastructure | Analysis of Application Settings for Cells 1.0. | Application Settings analysis | null |
<!--
This documentation is auto generated by a Ruby script.
Please do not edit this file directly. To update this file, run:
scripts/cells/application-settings-analysis.rb
-->
## Statistics
- Number of attributes: 499
- Number of encrypted attributes: 42 (8.0%)
- Number of attributes documented: 294 (59.0%)
... | ---
stage: Tenant Scale
group: Cells Infrastructure
info: Analysis of Application Settings for Cells 1.0.
title: Application Settings analysis
breadcrumbs:
- doc
- development
- cells
---
<!--
This documentation is auto generated by a Ruby script.
Please do not edit this file directly. To update this file, run:
... |
https://docs.gitlab.com/development/secure_partner_integration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/secure_partner_integration.md | 2025-08-13 | doc/development/integrations | [
"doc",
"development",
"integrations"
] | secure_partner_integration.md | Application Security Testing | Static Analysis | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Secure Partner Integration - Onboarding Process | null |
If you want to integrate your product with the [Secure Stage](https://about.gitlab.com/direction/secure/),
this page describes the developer workflow GitLab intends for
our users to follow with regards to security results. These should be used as
guidelines so you can build an integration that fits with the workflow ... | ---
stage: Application Security Testing
group: Static Analysis
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Secure Partner Integration - Onboarding Process
breadcrum... |
https://docs.gitlab.com/development/jira_connect | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/jira_connect.md | 2025-08-13 | doc/development/integrations | [
"doc",
"development",
"integrations"
] | jira_connect.md | Plan | Project Management | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab for Jira Cloud app development | null |
Developers have several options for how set up a development environment for the GitLab for Jira Cloud app:
1. A full environment [with Jira](#set-up-with-jira). Use this when you need to test interactions with Jira.
1. A full environment [with a Jira Connect proxy](#setting-up-a-jira-connect-proxy). Use this when y... | ---
stage: Plan
group: Project Management
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab for Jira Cloud app development
breadcrumbs:
- doc
- development
- integ... |
https://docs.gitlab.com/development/secure | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/secure.md | 2025-08-13 | doc/development/integrations | [
"doc",
"development",
"integrations"
] | secure.md | Application Security Testing | Static Analysis | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Security scanner integration | null |
Integrating a security scanner into GitLab consists of providing end users
with a [CI/CD job definition](../../ci/jobs/_index.md)
they can add to their CI/CD configuration files to scan their GitLab projects.
This job should then output its results in a GitLab-specified format. These results are then
automatically pr... | ---
stage: Application Security Testing
group: Static Analysis
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Security scanner integration
breadcrumbs:
- doc
- develop... |
https://docs.gitlab.com/development/integrations | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/integrations | [
"doc",
"development",
"integrations"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Integration development guidelines | Development guidelines for Integrations |
This page provides development guidelines for implementing [GitLab integrations](../../user/project/integrations/_index.md),
which are part of our [main Rails project](https://gitlab.com/gitlab-org/gitlab).
Also see our [direction page](https://about.gitlab.com/direction/manage/import_and_integrate/integrations/) fo... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: Development guidelines for Integrations
title: Integration development guideline... |
https://docs.gitlab.com/development/jenkins | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/jenkins.md | 2025-08-13 | doc/development/integrations | [
"doc",
"development",
"integrations"
] | jenkins.md | Create | Import | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | How to run Jenkins in development environment (on macOS) | null |
This is a step by step guide on how to set up [Jenkins](https://www.jenkins.io/) on your local machine and connect to it from your GitLab instance. GitLab triggers webhooks on Jenkins, and Jenkins connects to GitLab using the API. By running both applications on the same machine, we can make sure they are able to acc... | ---
stage: Create
group: Import
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: How to run Jenkins in development environment (on macOS)
breadcrumbs:
- doc
- developmen... |
https://docs.gitlab.com/development/working_with_uploads | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/working_with_uploads.md | 2025-08-13 | doc/development/uploads | [
"doc",
"development",
"uploads"
] | working_with_uploads.md | SaaS Platforms | Scalability | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Uploads guide: Adding new uploads | null |
## Recommendations
- When creating an uploader, [make it a subclass](#where-should-you-store-your-files) of `AttachmentUploader`
- Add your uploader to the [tables](#tables) in this document
- Do not add [new object storage buckets](#where-should-you-store-your-files)
- Implement [direct upload](#implementing-direct... | ---
stage: SaaS Platforms
group: Scalability
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: 'Uploads guide: Adding new uploads'
breadcrumbs:
- doc
- development
- uplo... |
https://docs.gitlab.com/development/uploads | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/uploads | [
"doc",
"development",
"uploads"
] | _index.md | SaaS Platforms | Scalability | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Uploads development guidelines | null |
Uploads are an integral part of many GitLab features. To understand how GitLab handles uploads, this page
provides an overview of the key mechanisms for transferring files to a storage destination.
GitLab uploads are configured by feature. All features that involve uploads provide the same configuration options,
but... | ---
stage: SaaS Platforms
group: Scalability
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Uploads development guidelines
breadcrumbs:
- doc
- development
- uploads
-... |
https://docs.gitlab.com/development/data_science | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/data_science | [
"doc",
"development",
"data_science"
] | _index.md | ModelOps | MLOps | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Data Science | null |
- [Model Registry](model_registry/_index.md)
| ---
stage: ModelOps
group: MLOps
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Data Science
breadcrumbs:
- doc
- development
- data_science
---
- [Model Registry](m... |
https://docs.gitlab.com/development/data_science/model_registry | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/data_science/_index.md | 2025-08-13 | doc/development/data_science/model_registry | [
"doc",
"development",
"data_science",
"model_registry"
] | _index.md | ModelOps | MLOps | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Model Registry | null |
Model registry is the component in the MLOps lifecycle responsible for managing
model versions. Beyond tracking just artifacts, it is responsible to track the
metadata associated to each model, like:
- Performance
- Parameters
- Data lineage
## Data topology
All entities belong to a project, and only users with ac... | ---
stage: ModelOps
group: MLOps
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Model Registry
breadcrumbs:
- doc
- development
- data_science
- model_registry
---
M... |
https://docs.gitlab.com/development/controls | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/controls.md | 2025-08-13 | doc/development/feature_flags | [
"doc",
"development",
"feature_flags"
] | controls.md | none | unassigned | See the Technical Writers assigned to Development Guidelines: https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines | Use ChatOps to enable and disable feature flags | null |
{{< alert type="note" >}}
This document explains how to contribute to the development of the GitLab product.
If you want to use feature flags to show and hide functionality in your own applications,
view [this feature flags information](../../operations/feature_flags.md) instead.
{{< /alert >}}
To turn on/off feat... | ---
stage: none
group: unassigned
info: 'See the Technical Writers assigned to Development Guidelines: https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines'
title: Use ChatOps to enable and disable feature flags
breadcrumbs:
- doc
- development
- feature_flags
---
{... |
https://docs.gitlab.com/development/feature_flags | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/feature_flags | [
"doc",
"development",
"feature_flags"
] | _index.md | none | unassigned | See the Technical Writers assigned to Development Guidelines: https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines | Feature flags in the development of GitLab | Developer documentation about GitLab feature flags. |
This page explains how developers contribute to the development and operations of the GitLab product
through feature flags. To create custom feature flags to show and hide features in your own applications,
see [Create a feature flag](../../operations/feature_flags.md#create-a-feature-flag).
A [complete list of featu... | ---
stage: none
group: unassigned
info: 'See the Technical Writers assigned to Development Guidelines: https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines'
description: Developer documentation about GitLab feature flags.
title: Feature flags in the development of Git... |
https://docs.gitlab.com/development/push_rules | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/push_rules | [
"doc",
"development",
"push_rules"
] | _index.md | Create | Source Code | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Push rules development guidelines | null |
This document was created to help contributors understand the code design of
[push rules](../../user/project/repository/push_rules.md). You should read this
document before making changes to the code for this feature.
This document is intentionally limited to an overview of how the code is
designed, as code can chan... | ---
stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Push rules development guidelines
breadcrumbs:
- doc
- development
- push_rules
---... |
https://docs.gitlab.com/development/prevention-patterns | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/prevention-patterns.md | 2025-08-13 | doc/development/transient | [
"doc",
"development",
"transient"
] | prevention-patterns.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Preventing Transient Bugs | null |
This page covers architectural patterns and tips for developers to follow to prevent [transient bugs.](https://handbook.gitlab.com/handbook/engineering/infrastructure/engineering-productivity/issue-triage/#transient-bugs)
## Common root causes
We've noticed a few root causes that come up frequently when addressing ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Preventing Transient Bugs
breadcrumbs:
- doc
- development
- transient
---
This page... |
https://docs.gitlab.com/development/tips | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/tips.md | 2025-08-13 | doc/development/advanced_search | [
"doc",
"development",
"advanced_search"
] | tips.md | AI-powered | Global Search | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Advanced search development tips | null |
## Kibana
Use Kibana to interact with your Elasticsearch cluster.
See the [download instructions](https://www.elastic.co/guide/en/kibana/8.11/install.html).
## Viewing index status
Run
```shell
bundle exec rake gitlab:elastic:info
```
to see the status and information about your cluster.
## Creating all indice... | ---
stage: AI-powered
group: Global Search
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Advanced search development tips
breadcrumbs:
- doc
- development
- advanced_... |
https://docs.gitlab.com/development/add_new_template | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/add_new_template.md | 2025-08-13 | doc/development/project_templates | [
"doc",
"development",
"project_templates"
] | add_new_template.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Contribute to built-in project templates | null |
GitLab provides some
[built-in project templates](../../user/project/_index.md#create-a-project-from-a-built-in-template)
that you can use when creating a new project.
Built-in templates are sourced from the following groups:
- [`gitlab-org/project-templates`](https://gitlab.com/gitlab-org/project-templates)
- [`pa... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Contribute to built-in project templates
breadcrumbs:
- doc
- development
- project_templates
--... |
https://docs.gitlab.com/development/project_templates | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/project_templates | [
"doc",
"development",
"project_templates"
] | _index.md | Create | Source Code | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Custom group-level project templates development guidelines | null |
This document was created to help contributors understand the code design of
[custom group-level project templates](../../user/group/custom_project_templates.md).
You should read this document before making changes to the code for this feature.
This document is intentionally limited to an overview of how the code is... | ---
stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Custom group-level project templates development guidelines
breadcrumbs:
- doc
- de... |
https://docs.gitlab.com/development/value_stream_analytics_aggregated_backend | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/value_stream_analytics_aggregated_backend.md | 2025-08-13 | doc/development/value_stream_analytics | [
"doc",
"development",
"value_stream_analytics"
] | value_stream_analytics_aggregated_backend.md | Plan | Optimize | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Aggregated Value Stream Analytics | null |
{{< alert type="disclaimer" />}}
This page provides a high-level overview of the aggregated backend for
Value Stream Analytics (VSA).
## Current Status
The aggregated backend is used by default since GitLab 15.0 on the group-level.
## Motivation
The aggregated backend aims to solve the performance limitations of... | ---
stage: Plan
group: Optimize
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Aggregated Value Stream Analytics
breadcrumbs:
- doc
- development
- value_stream_analyt... |
https://docs.gitlab.com/development/code_owners | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/code_owners | [
"doc",
"development",
"code_owners"
] | _index.md | Create | Source Code | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Code Owners development guidelines | null |
This document was created to help contributors understand the code design of
[Code Owners](../../user/project/codeowners/_index.md). You should read this
document before making changes to the code for this feature.
This document is intentionally limited to an overview of how the code is
designed, as code can change ... | ---
stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Code Owners development guidelines
breadcrumbs:
- doc
- development
- code_owners
-... |
https://docs.gitlab.com/development/new_redis_instance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/new_redis_instance.md | 2025-08-13 | doc/development/redis | [
"doc",
"development",
"redis"
] | new_redis_instance.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Add a new Redis instance | null |
GitLab can make use of multiple [Redis instances](../redis.md#redis-instances).
These instances are functionally partitioned so that, for example, we
can store [CI trace chunks](../../administration/cicd/job_logs.md#incremental-logging)
from one Redis instance while storing sessions in another.
From time to time we ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Add a new Redis instance
breadcrumbs:
- doc
- development
- redis
---
GitLab can mak... |
https://docs.gitlab.com/development/testing_and_validation | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/testing_and_validation.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | testing_and_validation.md | null | null | null | null | null |
<!-- markdownlint-disable -->
This document was moved to [another location](ai_evaluation_guidelines.md).
<!-- This redirect file can be deleted after <2025-10-30>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redirects that point to docs in a different project or... | ---
redirect_to: ai_evaluation_guidelines.md
remove_date: '2025-10-30'
breadcrumbs:
- doc
- development
- ai_features
---
<!-- markdownlint-disable -->
This document was moved to [another location](ai_evaluation_guidelines.md).
<!-- This redirect file can be deleted after <2025-10-30>. -->
<!-- Redirects that point... |
https://docs.gitlab.com/development/ai_development_license | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/ai_development_license.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | ai_development_license.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Duo licensing for local development | Documentation about GitLab Duo licensing options for local development |
To use GitLab Duo Features, you need to:
- Use GitLab enterprise edition
- Have an online cloud license
- Have either Premium or Ultimate Subscription License plan
- Have one of the Duo add-ons in addition to your license plan (Duo Core, Duo Pro, or Duo Enterprise)
This document walks you through how to get ensure ... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: Documentation about GitLab Duo licensing options for local development
t... |
https://docs.gitlab.com/development/actions | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/actions.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | actions.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | AI actions | null |
This page includes how to implement actions and migrate them to the AI Gateway.
## How to implement a new action
Implementing a new AI action will require changes across different components.
We'll use the example of wanting to implement an action that allows users to rewrite issue descriptions according to
a given... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: AI actions
breadcrumbs:
- doc
- development
- ai_features
---
This page incl... |
https://docs.gitlab.com/development/composite_identity | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/composite_identity.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | composite_identity.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Composite Identity | null |
GitLab Duo with Amazon Q uses a [composite identity](../../user/gitlab_duo/security.md)
to authenticate requests.
For security reasons, you should use composite identity for any
AI-generated activity on the GitLab platform that performs write actions.
## Prerequisites
To generate a composite identity token, you mu... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Composite Identity
breadcrumbs:
- doc
- development
- ai_features
---
GitLab... |
https://docs.gitlab.com/development/prompt_engineering | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/prompt_engineering.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | prompt_engineering.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Prompt Engineering Guide | null |
This guide outlines the key aspects of prompt engineering when working with Large Language Models (LLMs),
including prompt design, optimization, evaluation, and monitoring.
## Understanding prompt engineering
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For an overview, see [this video](https://you... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Prompt Engineering Guide
breadcrumbs:
- doc
- development
- ai_features
---
... |
https://docs.gitlab.com/development/ai_evaluation_guidelines | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/ai_evaluation_guidelines.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | ai_evaluation_guidelines.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | AI Evaluation Guidelines | null |
Unlike traditional software systems that behave more-or-less predictably, minor input changes can cause AI-powered systems to produce significantly different outputs. This unpredictability stems from the non-deterministic nature of AI-generated responses. Traditional software testing methods are not designed to handl... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: AI Evaluation Guidelines
breadcrumbs:
- doc
- development
- ai_features
---
... |
https://docs.gitlab.com/development/availability | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/availability.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | availability.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Duo Feature Availability and Configuration | null |
This document explains how GitLab Duo features are controlled, who can access them, and how they are configured across GitLab deployments.
## Controlling GitLab Duo Feature Availability
Various settings control when and how users can interact with GitLab Duo features. The
[end-user documentation](../../user/gitlab_... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab Duo Feature Availability and Configuration
breadcrumbs:
- doc
- develop... |
https://docs.gitlab.com/development/model_migration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/model_migration.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | model_migration.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Model Migration Process | null |
## Current Migration Issues
The table below shows current open issues labeled with `AI Model Migration`. This provides a live view of ongoing model migration work across GitLab.
```glql
display: table
fields: title, author, assignee, milestone, labels, updated
limit: 10
query: label = "AI Model Migration" AND opene... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Model Migration Process
breadcrumbs:
- doc
- development
- ai_features
---
#... |
https://docs.gitlab.com/development/code_suggestions | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/code_suggestions.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | code_suggestions.md | Create | Code Creation | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Code Suggestions development guidelines | Code Suggestions documentation for developers interested in contributing features or bugfixes. |
## Code Suggestions development setup
The recommended setup for locally developing and debugging Code Suggestions is to have all 3 different components running:
- IDE Extension (for example, GitLab Workflow extension for VS Code).
- Main application configured correctly (for example, GDK).
- [AI gateway](https://gi... | ---
stage: Create
group: Code Creation
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: Code Suggestions documentation for developers interested in contributing
... |
https://docs.gitlab.com/development/ai_feature_development_playbook | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/ai_feature_development_playbook.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | ai_feature_development_playbook.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | AI feature development playbook | null |
This playbook outlines our approach to developing AI features at GitLab, similar to and concurrent with [the Build track of our product development flow](https://handbook.gitlab.com/handbook/product-development/product-development-flow/#build-track). It serves as a playbook for AI feature development and operational ... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: AI feature development playbook
breadcrumbs:
- doc
- development
- ai_features... |
https://docs.gitlab.com/development/embeddings | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/embeddings.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | embeddings.md | AI-powered | Global Search | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Embeddings | null |
Embeddings are a way of representing data in a vectorised format, making it easy and efficient to find similar documents.
Currently embeddings are only generated for issues which allows for features such as
- [Issue search](https://gitlab.com/gitlab-org/gitlab/-/issues/440424)
- [Find similar issues](https://gitlab... | ---
stage: AI-powered
group: Global Search
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Embeddings
breadcrumbs:
- doc
- development
- ai_features
---
Embeddings ar... |
https://docs.gitlab.com/development/logged_events | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/logged_events.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | logged_events.md | AI-powered | AI Framework | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Logged events | null |
In addition to standard logging in the GitLab Rails Monolith instance, specialized logging is available for features based on large language models (LLMs).
## Events logged
<!-- markdownlint-disable -->
<!-- vale off -->
### Returning from Service due to validation
- Description: user not permitted to perform a... | ---
stage: AI-powered
group: AI Framework
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Logged events
breadcrumbs:
- doc
- development
- ai_features
---
In addition to standard ... |
https://docs.gitlab.com/development/logging | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/logging.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | logging.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | LLM logging | null |
In addition to standard logging in the GitLab Rails Monolith instance, specialized logging is available for features based on large language models (LLMs).
## Logged events
Currently logged events are documented [here](logged_events.md).
## Implementation
### Logger Class
To implement LLM-specific logging, use t... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: LLM logging
breadcrumbs:
- doc
- development
- ai_features
---
In addition t... |
https://docs.gitlab.com/development/ai_features | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | _index.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | AI features based on 3rd-party integrations | null |
GitLab Duo features are powered by AI models and integrations. This document provides an overview of developing with AI features in GitLab.
For detailed instructions on setting up GitLab Duo licensing in your development environment, see [GitLab Duo licensing for local development](ai_development_license.md).
## In... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: AI features based on 3rd-party integrations
breadcrumbs:
- doc
- development
-... |
https://docs.gitlab.com/development/duo_chat | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/duo_chat.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | duo_chat.md | AI-powered | Duo Chat | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Duo Chat | null |
GitLab Duo Chat aims to assist users with AI in ideation and creation tasks as
well as in learning tasks across the entire Software Development Lifecycle
(SDLC) to make them faster and more efficient.
[Chat](../../user/gitlab_duo_chat/_index.md) is a part of the [GitLab Duo](../../user/gitlab_duo/_index.md)
offering... | ---
stage: AI-powered
group: Duo Chat
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab Duo Chat
breadcrumbs:
- doc
- development
- ai_features
---
GitLab Duo Ch... |
https://docs.gitlab.com/development/local_models | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/local_models.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | local_models.md | AI-powered | Custom Models | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Serve Large Language Models APIs Locally | null |
There are several ways to serve large language models (LLMs) for local or self-deployment purposes.
[MistralAI](https://docs.mistral.ai/deployment/self-deployment/overview/) recommends two different serving frameworks for their models:
- [vLLM](https://docs.vllm.ai/en/latest/): A Python-only serving framework which... | ---
stage: AI-powered
group: Custom Models
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Serve Large Language Models APIs Locally
breadcrumbs:
- doc
- development
- ai_features
--... |
https://docs.gitlab.com/development/duo_agent_platform | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/duo_agent_platform.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | duo_agent_platform.md | AI-powered | Duo Agent Platform | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Duo Agent Platform | null |
This guide explains how to work with the Duo Agent Platform.
## Overview
The Duo Agent Platform is a Single Page Application (SPA) built with Vue.js that provides a unified interface for AI-powered automation features. The platform uses a scoped routing system that allows multiple navigation items to coexist under ... | ---
stage: AI-powered
group: Duo Agent Platform
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab Duo Agent Platform
breadcrumbs:
- doc
- development
- ai_features... |
https://docs.gitlab.com/development/vertex_model_enablement_process | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/vertex_model_enablement_process.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | vertex_model_enablement_process.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Vertex AI Model Enablement Process | null |
## Production Environment Setup
### 1. Request Initiation
- Create an issue in the [GitLab project](https://gitlab.com/gitlab-org/gitlab/-/issues)
- Use the Model Enablement Request template - see below
- Specify the model(s) to be enabled (e.g., Codestral)
- Share the issue link in the `#ai-infrastructure` cha... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Vertex AI Model Enablement Process
breadcrumbs:
- doc
- development
- ai_featu... |
https://docs.gitlab.com/development/amazon_q_integration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/amazon_q_integration.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | amazon_q_integration.md | AI-powered | Custom Models | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Amazon Q integration for testing and evaluation | null |
This guide combines and builds on the following guides and sources. It describes Amazon Q set-up for testing and evaluation purposes:
- [Set up GitLab Duo with Amazon Q](../../user/duo_amazon_q/setup.md)
- [code-suggestions development guide](code_suggestions.md)
This guide describes how to set up Amazon Q in a Git... | ---
stage: AI-powered
group: Custom Models
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Amazon Q integration for testing and evaluation
breadcrumbs:
- doc
- developm... |
https://docs.gitlab.com/development/glossary | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/glossary.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | glossary.md | AI-powered | AI Framework | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Duo Glossary | null |
This is a list of terms that may have a general meaning but also may have a
specific meaning at GitLab. If you encounter a piece of technical jargon related
to AI that you think could benefit from being in this list, add it!
## General terminology
### Adapters
A variation on Fine Tuning. Instead of opening the mod... | ---
stage: AI-powered
group: AI Framework
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab Duo Glossary
breadcrumbs:
- doc
- development
- ai_features
---
This is a list of ... |
https://docs.gitlab.com/development/developing_ai_features_for_duo_self_hosted | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/developing_ai_features_for_duo_self_hosted.md | 2025-08-13 | doc/development/ai_features | [
"doc",
"development",
"ai_features"
] | developing_ai_features_for_duo_self_hosted.md | AI-powered | Custom Models | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review. | Developing AI Features for Duo Self-Hosted | null |
This document outlines the process for developing AI features for GitLab Duo Self-Hosted. Developing AI features for GitLab Duo Self-Hosted is quite similar to developing AI features for Duo SaaS, but there are some differences.
## Gaining access to a hosted model
The following models are currently available to Git... | ---
stage: AI-powered
group: Custom Models
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review.
title: Developing AI Features for Duo Self-Hosted
breadcrumbs:
- doc
- develo... |
https://docs.gitlab.com/development/ai_features/evaluation_runner | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/ai_features/_index.md | 2025-08-13 | doc/development/ai_features/evaluation_runner | [
"doc",
"development",
"ai_features",
"evaluation_runner"
] | _index.md | AI-powered | AI Framework | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Evaluation runner | null |
Evaluation runner (`evaluation-runner`) allows GitLab employees to run evaluations on specific GitLab AI features with one click.
- You can run the evaluation on GitLab.com and GitLab-supported self-hosted models.
- To view the AI features that are currently supported, see
[Evaluation pipelines](https://gitlab.com... | ---
stage: AI-powered
group: AI Framework
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Evaluation runner
breadcrumbs:
- doc
- development
- ai_features
- evaluation_... |
https://docs.gitlab.com/development/security_report_ingestion_overview | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/security_report_ingestion_overview.md | 2025-08-13 | doc/development/sec | [
"doc",
"development",
"sec"
] | security_report_ingestion_overview.md | Security Risk Management | Security Insights | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Security report ingestion overview | null |
{{< alert type="warning" >}}
The `Vulnerability::Feedback` model is currently undergoing deprecation and should be actively avoided in all further development. It is currently maintained with feature parity to enable revert should any issues arise, but is intended to be removed in 16.0. Any interactions relating to ... | ---
stage: Security Risk Management
group: Security Insights
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Security report ingestion overview
breadcrumbs:
- doc
- development
- se... |
https://docs.gitlab.com/development/generate_test_vulnerabilities | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/generate_test_vulnerabilities.md | 2025-08-13 | doc/development/sec | [
"doc",
"development",
"sec"
] | generate_test_vulnerabilities.md | Security Risk Management | Security Insights | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Generate test vulnerabilities | null |
You can generate test vulnerabilities for the [Vulnerability Report](../../user/application_security/vulnerability_report/_index.md) to test GitLab
vulnerability management features without running a pipeline.
1. Sign in to GitLab.
1. Go to `/-/user_settings/personal_access_tokens` and generate a personal access tok... | ---
stage: Security Risk Management
group: Security Insights
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Generate test vulnerabilities
breadcrumbs:
- doc
- developm... |
https://docs.gitlab.com/development/analyzer_development_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/analyzer_development_guide.md | 2025-08-13 | doc/development/sec | [
"doc",
"development",
"sec"
] | analyzer_development_guide.md | Application Security Testing | Static Analysis | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sec section analyzer development | null |
Analyzers are shipped as Docker images to execute within a CI pipeline context. This guide describes development and testing
practices across analyzers.
## Shared modules
There are a number of shared Go modules shared across analyzers for common behavior and interfaces:
- The [`command`](https://gitlab.com/gitlab-... | ---
stage: Application Security Testing
group: Static Analysis
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sec section analyzer development
breadcrumbs:
- doc
- dev... |
https://docs.gitlab.com/development/cyclonedx_property_taxonomy | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/cyclonedx_property_taxonomy.md | 2025-08-13 | doc/development/sec | [
"doc",
"development",
"sec"
] | cyclonedx_property_taxonomy.md | Security Risk Management | Security Insights | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab CycloneDX property taxonomy | null |
This document defines the namespaces and properties used by the `gitlab` namespace
in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy).
{{< alert type="note" >}}
Before making changes to this file, reach out to the threat insights engineering team,
`@gitlab-org/govern/thre... | ---
stage: Security Risk Management
group: Security Insights
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab CycloneDX property taxonomy
breadcrumbs:
- doc
- development
- se... |
https://docs.gitlab.com/development/token_revocation_api | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/token_revocation_api.md | 2025-08-13 | doc/development/sec | [
"doc",
"development",
"sec"
] | token_revocation_api.md | Application Security Testing | Static Analysis | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Token Revocation API | null |
The Token Revocation API is an externally-deployed HTTP API that interfaces with GitLab
to receive and revoke API tokens and other secrets detected by GitLab Secret Detection.
See the [high-level architecture](../../user/application_security/secret_detection/automatic_response.md)
to understand the Secret Detection p... | ---
stage: Application Security Testing
group: Static Analysis
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Token Revocation API
breadcrumbs:
- doc
- development
- sec
---
The ... |
https://docs.gitlab.com/development/sbom_dependency_graph_ingestion_overview | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/sbom_dependency_graph_ingestion_overview.md | 2025-08-13 | doc/development/sec | [
"doc",
"development",
"sec"
] | sbom_dependency_graph_ingestion_overview.md | Security Risk Management | Security Insights | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | SBoM dependency graph ingestion overview | null |
## Overview
The process starts after all `SBoM::Occurrence` models have been ingested because we ingest them in slices and it would be tricky to process that in slices as well.
All work happens in a background worker which will be added in a subsequent MR so that we do not increase the time it takes to ingest an SB... | ---
stage: Security Risk Management
group: Security Insights
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: SBoM dependency graph ingestion overview
breadcrumbs:
- doc
- developmen... |
https://docs.gitlab.com/development/gemnasium_analyzer_data | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/gemnasium_analyzer_data.md | 2025-08-13 | doc/development/sec | [
"doc",
"development",
"sec"
] | gemnasium_analyzer_data.md | Application Security Testing | Composition Analysis | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Gemnasium analyzer data | null |
The following table lists the data available for the Gemnasium analyzer.
| Property \ Tool | Gemnasium |
|:----------------------------------------------|:---------:|
| Severity | {{< icon name="check-circle" >}} Yes |
| Title ... | ---
stage: Application Security Testing
group: Composition Analysis
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Gemnasium analyzer data
breadcrumbs:
- doc
- develop... |
https://docs.gitlab.com/development/sec | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/sec | [
"doc",
"development",
"sec"
] | _index.md | Application Security Testing | Static Analysis | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sec section development guidelines | null |
The Sec section is responsible for GitLab application security features, the "Sec" part of
DevSecOps. Development guides that are specific to the Sec section are listed here.
See [Terminology](../../user/application_security/terminology/_index.md) for an overview of our shared terminology.
## Architecture
- [Overv... | ---
stage: Application Security Testing
group: Static Analysis
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sec section development guidelines
breadcrumbs:
- doc
- d... |
https://docs.gitlab.com/development/vulnerability_tracking | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/vulnerability_tracking.md | 2025-08-13 | doc/development/sec | [
"doc",
"development",
"sec"
] | vulnerability_tracking.md | Security Risk Management | Security Insights | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Vulnerability tracking overview | null |
At GitLab we run Git combined with automated security testing in Continuous
Integration and Continuous Delivery (CI/CD) processes. These processes
continuously monitor code changes to detect security vulnerabilities as early
as possible. Security testing often involves multiple Static Application
Security Testing (SA... | ---
stage: Security Risk Management
group: Security Insights
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Vulnerability tracking overview
breadcrumbs:
- doc
- development
- sec
-... |
https://docs.gitlab.com/development/testing_levels | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/testing_levels.md | 2025-08-13 | doc/development/testing_guide | [
"doc",
"development",
"testing_guide"
] | testing_levels.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Testing levels | null |
_This diagram demonstrates the relative priority of each test type we use. `e2e` stands for end-to-end._
As of 2025-02-03, we have the following estimated distribution of tests per level:
| Test level ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Testing levels
breadcrumbs:
- doc
- development
- testing_guide
---
![Testing priori... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.