2024-01-24 16:29:14 +09:00 · 2024-01-24 16:29:14 +09:00 · 4ec342fa4a
parent 81034e2f64
commit 4ec342fa4a
29 changed files with 151 additions and 71 deletions
--- a/doc/.vale/gitlab/VersionText.yml
+++ b/doc/.vale/gitlab/VersionText.yml
@ -1,19 +0,0 @@
---
-# Error: gitlab.VersionText
-#
-# Checks that multi-line version text is formatted correctly.
-#
-# Specifically, looks for multi-line version text that doesn't use `-` to make it a list.
-# For example:
-#
-# - `> Introduced in GitLab 14.0.
-# - `> Removed in GitLab 15.0.
-#
-# For a list of all options, see https://vale.sh/docs/topics/styles/
-extends: existence
-message: "Start each entry with `> -`. Keep long entries on one line."
-link: https://docs.gitlab.com/ee/development/documentation/versions.html
-level: error
-scope: raw
-raw:
-  - '\n#.*\n\n> [^-].+\n[^\n`]'
--- a/doc/.vale/gitlab/VersionTextSingleLine.yml
+++ b/doc/.vale/gitlab/VersionTextSingleLine.yml
@ -1,13 +0,0 @@
---
-# Error: gitlab.VersionTextSingleLine
-#
-# Verifies that single-item version notes don't have a hyphen.
-#
-# For a list of all options, see https://vale.sh/docs/topics/styles/
-extends: existence
-message: "Do not use a hyphen '-' in version text if there is only a single item."
-link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item
-level: error
-scope: raw
-raw:
-  - '(\r|\n|\r\n){2}(> - .*)(\r|\n|\r\n){2}'
--- a/doc/index.md
+++ b/doc/index.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Linux package documentation **(FREE SELF)**
+# Linux package documentation
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 The Linux package has different services and tools required to run GitLab. Most users can install it without laborious
 configuration.
--- a/doc/installation/index.md
+++ b/doc/installation/index.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Install GitLab with the Linux package **(FREE SELF)**
+# Install GitLab with the Linux package
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 ## Prerequisites

@ -44,7 +48,7 @@ For a complete list of settings, see the [README](../index.md#configuring) file.

 ### Set up the initial password

-> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5331) in GitLab 14.0.
+> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5331) in GitLab 14.0.

 By default, a Linux package installation automatically generates a password for the
 initial administrator user account (`root`) and stores it to
--- a/doc/maintenance/index.md
+++ b/doc/maintenance/index.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Maintenance commands **(FREE SELF)**
+# Maintenance commands
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 The following commands can be run after installation.

--- a/doc/roles/index.md
+++ b/doc/roles/index.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Omnibus GitLab High Availability Roles **(FREE SELF)**
+# Omnibus GitLab High Availability Roles
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 Omnibus GitLab includes various software components/services to support running GitLab in
 a high availability configuration. By default, some of these supporting services
@ -113,7 +117,7 @@ for configuration steps.

 ### Monitoring Roles

-> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/3404) in GitLab 12.1.
+> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/3404) in GitLab 12.1.

 Monitoring roles are used to set up monitoring of installations. For additional information, see the [Monitoring documentation](https://docs.gitlab.com/ee/administration/monitoring/prometheus/index.html).

@ -153,7 +157,7 @@ Documentation on the usage of the PostgreSQL Roles can be found in [Configuring

 ### GitLab Pages Roles

-> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/4740) in GitLab 13.6.
+> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/4740) in GitLab 13.6.

 GitLab Pages roles are used to setup and configure GitLab Pages. For additional
 information, see the
@ -167,7 +171,7 @@ information, see the

 ### Sidekiq Roles

-> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5365) in GitLab 14.1.
+> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5365) in GitLab 14.1.

 Sidekiq roles are used to setup and configure Sidekiq. For additional
 information, see the
@ -181,7 +185,7 @@ information, see the

 ### Spamcheck Roles

-> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5893) in GitLab 14.9.
+> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5893) in GitLab 14.9.

 Spamcheck roles are used to setup and configure Spamcheck services. For additional
 information, see the
--- a/doc/settings/actioncable.md
+++ b/doc/settings/actioncable.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Action Cable **(FREE SELF)**
+# Action Cable
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 Action Cable is a Rails engine that handles websocket connections.

--- a/doc/settings/backups.md
+++ b/doc/settings/backups.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Backup **(FREE SELF)**
+# Backup
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 ## Backup and restore configuration on a Linux package installation

@ -64,7 +68,7 @@ Your machines SSH host keys are stored in a separate location at `/etc/ssh/`. Be

 ### Limit backup lifetime for configuration backups (prune old backups)

-> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5102) in GitLab 13.12.
+> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5102) in GitLab 13.12.

 GitLab configuration backups can be pruned using the same `backup_keep_time` setting that is
 [used for the GitLab application backups](https://docs.gitlab.com/ee/administration/backup_restore/backup_gitlab.html#limit-backup-lifetime-for-local-files-prune-old-backups)
--- a/doc/settings/configuration.md
+++ b/doc/settings/configuration.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Configuration options for Linux package installations **(FREE SELF)**
+# Configuration options for Linux package installations
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 To configure GitLab, set the relevant options in the `/etc/gitlab/gitlab.rb` file.

--- a/doc/settings/database.md
+++ b/doc/settings/database.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Database settings **(FREE SELF)**
+# Database settings
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 GitLab supports only the PostgreSQL database management system.

@ -576,7 +580,7 @@ this.

 ### Configuring multiple database connections

-> The `gitlab:db:decomposition:connection_status` Rake task was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111927) in GitLab 15.11.
+> - The `gitlab:db:decomposition:connection_status` Rake task was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111927) in GitLab 15.11.

 In GitLab 16.0, GitLab defaults to using two database connections that point to the same PostgreSQL database.

@ -1054,7 +1058,7 @@ parameters noted in the table below and then run `gitlab-ctl reconfigure`.

 ## Automatic database reindexing

-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/249662) in GitLab 13.5.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/249662) in GitLab 13.5.

 WARNING:
 This is an experimental feature that isn't enabled by default.
--- a/doc/settings/dns.md
+++ b/doc/settings/dns.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# DNS settings **(FREE SELF)**
+# DNS settings
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 The Domain Name System (DNS) is the naming system used to match IP addresses
 with domain names.
--- a/doc/settings/environment-variables.md
+++ b/doc/settings/environment-variables.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Setting custom environment variables **(FREE SELF)**
+# Setting custom environment variables
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 If necessary you can set custom environment variables to be used by Puma,
 Sidekiq, Rails and Rake via `/etc/gitlab/gitlab.rb`. This can be useful in
--- a/doc/settings/gitlab.yml.md
+++ b/doc/settings/gitlab.yml.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Changing `gitlab.yml` and `application.yml` settings **(FREE SELF)**
+# Changing `gitlab.yml` and `application.yml` settings
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 Some GitLab features can be customized through
 [`gitlab.yml`](https://gitlab.com/gitlab-org/gitlab-foss/blob/master/config/gitlab.yml.example). If you want to change a `gitlab.yml` setting
--- a/doc/settings/image_scaling.md
+++ b/doc/settings/image_scaling.md
@ -4,7 +4,11 @@ group: Application Performance
 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
 ---

-# Image scaling **(FREE SELF)**
+# Image scaling
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 GitLab runs a built-in image scaler to improve site rendering performance. It is enabled by default.

--- a/doc/settings/index.md
+++ b/doc/settings/index.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Configuring a Linux package installation **(FREE SELF)**
+# Configuring a Linux package installation
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 - [Asset proxy server](https://docs.gitlab.com/ee/security/asset_proxy.html)
 - [Backups](backups.md)
--- a/doc/settings/logs.md
+++ b/doc/settings/logs.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Logs on Linux package installations **(FREE SELF)**
+# Logs on Linux package installations
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 GitLab includes an [advanced log system](https://docs.gitlab.com/ee/administration/logs/index.html) where every service and component within GitLab will output system logs.
 Here are the configuration settings and tools for managing these logs on Linux package installations.
@ -166,7 +170,11 @@ To manually trigger GitLab log rotation with `logrotate`, use the following comm
 /opt/gitlab/embedded/sbin/logrotate -fv -s /var/opt/gitlab/logrotate/logrotate.status /var/opt/gitlab/logrotate/logrotate.conf
 ```

-## UDP log forwarding **(PREMIUM SELF)**
+## UDP log forwarding
+
+DETAILS:
+**Tier:** Premium, Ultimate
+**Offering:** Self-managed

 Linux package installations can utilize the UDP logging feature in svlogd as well as sending non-svlogd logs to a syslog-compatible remote system using UDP.
 To configure a Linux package installation to send syslog-protocol messages via UDP, use the following settings:
--- a/doc/settings/memory_constrained_envs.md
+++ b/doc/settings/memory_constrained_envs.md
@ -4,7 +4,11 @@ group: Application Performance
 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
 ---

-# Running GitLab in a memory-constrained environment **(FREE SELF)**
+# Running GitLab in a memory-constrained environment
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 GitLab requires a significant amount of memory when running with all features enabled.
 There are use-cases such as running GitLab on smaller installations where not all functionality
--- a/doc/settings/microsoft_graph_mailer.md
+++ b/doc/settings/microsoft_graph_mailer.md
@ -4,9 +4,13 @@ group: Authentication and Authorization
 info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
 ---

-# Microsoft Graph Mailer settings **(FREE SELF)**
+# Microsoft Graph Mailer settings

-> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8259) in GitLab 15.5.
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed
+
+> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/8259) in GitLab 15.5.

 Prerequisites:

--- a/doc/settings/nginx.md
+++ b/doc/settings/nginx.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# NGINX settings **(FREE SELF)**
+# NGINX settings
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 ## Service-specific NGINX settings

--- a/doc/settings/praefect.md
+++ b/doc/settings/praefect.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Gitaly Cluster **(FREE SELF)**
+# Gitaly Cluster
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 [Gitaly Cluster](https://docs.gitlab.com/ee/administration/gitaly/praefect.html) provides
 fault-tolerant storage for repositories. It uses Praefect as a router and transaction manager for
--- a/doc/settings/prometheus.md
+++ b/doc/settings/prometheus.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Prometheus settings **(FREE SELF)**
+# Prometheus settings
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 ## Remote read/write

--- a/doc/settings/redis.md
+++ b/doc/settings/redis.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Configuring Redis **(FREE SELF)**
+# Configuring Redis
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 ## Using an alternate local Redis instance

--- a/doc/settings/rpi.md
+++ b/doc/settings/rpi.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Running on a Raspberry Pi **(FREE SELF)**
+# Running on a Raspberry Pi
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 In order to run GitLab Community Edition on a Raspberry Pi, you need the newest
 Pi 4 with at least 4GB of RAM for best results. You might be able to run GitLab
--- a/doc/settings/smtp.md
+++ b/doc/settings/smtp.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# SMTP settings **(FREE SELF)**
+# SMTP settings
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 If you would rather send application email via an SMTP server instead of via
 Sendmail or Postfix, add the following configuration information to
@ -42,7 +46,7 @@ gitlab_rails['smtp_ca_file'] = '/path/to/your/cacert.pem'

 ## SMTP connection pooling

-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230717) in GitLab 13.5.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230717) in GitLab 13.5.

 You can enable SMTP connection pooling with the following setting:

@ -54,7 +58,7 @@ This allows Sidekiq workers to reuse SMTP connections for multiple jobs. The max

 ## Using encrypted credentials

-> [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6276) in GitLab 14.3.
+> - [Introduced](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/6276) in GitLab 14.3.

 Instead of storing the SMTP credentials in the configuration files as plain text, you can optionally
 use an encrypted file for the SMTP credentials. To use this feature, you first need to enable
--- a/doc/settings/ssl/index.md
+++ b/doc/settings/ssl/index.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Configure SSL for a Linux package installation **(FREE SELF)**
+# Configure SSL for a Linux package installation
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 The Linux package supports several common use cases for SSL configuration.

--- a/doc/settings/ssl/ssl_troubleshooting.md
+++ b/doc/settings/ssl/ssl_troubleshooting.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Troubleshooting SSL **(FREE SELF)**
+# Troubleshooting SSL
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 This page contains a list of common SSL-related errors and scenarios that you
 may encounter while working with GitLab. It should serve as an addition to the
--- a/doc/troubleshooting.md
+++ b/doc/troubleshooting.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Troubleshooting Omnibus GitLab installation issues **(FREE SELF)**
+# Troubleshooting Omnibus GitLab installation issues
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 Use this page to learn about common issues users can encounter when installing Omnibus GitLab packages.

--- a/doc/update/convert_to_omnibus.md
+++ b/doc/update/convert_to_omnibus.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Upgrading from a non-Linux package installation to a Linux package installation **(FREE SELF)**
+# Upgrading from a non-Linux package installation to a Linux package installation
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 Upgrading from non-Linux package installations has not been tested by GitLab.

--- a/doc/update/package_signatures.md
+++ b/doc/update/package_signatures.md
@ -4,7 +4,11 @@ group: Distribution
 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
 ---

-# Cryptographic details related to `omnibus-gitlab` packages **(FREE SELF)**
+# Cryptographic details related to `omnibus-gitlab` packages
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** Self-managed

 GitLab uses a [packagecloud](https://packages.gitlab.com) instance to share the
 different OS packages it offers, and uses various cryptographic methods to