Document features deployed behind feature flags · Gitlab 中文文檔

# Document features deployed behind feature flags > 原文：[https://docs.gitlab.com/ee/development/documentation/feature_flags.html](https://docs.gitlab.com/ee/development/documentation/feature_flags.html) * [Criteria](#criteria) * [Features disabled by default](#features-disabled-by-default) * [Features that became enabled by default](#features-that-became-enabled-by-default) * [Features directly enabled by default](#features-directly-enabled-by-default) * [Features with flag removed](#features-with-flag-removed) # Document features deployed behind feature flags[](#document-features-deployed-behind-feature-flags "Permalink") manbetx 客戶端打不開使用[功能標志](../feature_flags/index.html)來戰略性地推出自己的功能的部署. 我們在功能標記后面記錄功能的方式取決于其狀態（啟用或禁用）. 狀態更改時，進行更改的開發人員**必須相應地更新文檔** . ## Criteria[](#criteria "Permalink") 根據[部署功能標記后的 GitLab 功能](../feature_flags/process.html)的過程： > * *默認情況下，功能標志應處于關閉狀態.* > * *功能標記應盡可能短地保留在代碼庫中，以減少對功能標記記帳的需求.* > * *為了構建最終版本并為自我管理的用戶提供功能，功能標志至少應至少默認為 on.* 根據標志的狀態，請參閱下面的文檔說明： * [Features disabled by default](#features-disabled-by-default). * [Features that became enabled by default](#features-that-became-enabled-by-default). * [Features directly enabled by default](#features-directly-enabled-by-default). * [Features with the feature flag removed](#features-with-flag-removed). **注意：**功能級別的[`**(CORE ONLY)**`](styleguide.html#product-badges)徽標或等效標記應添加到以下行和標題中，即啟用/禁用功能標志，因為這樣做需要管理員訪問權限，因此，它表示不能由 GitLab.com 的普通用戶完成. ### Features disabled by default[](#features-disabled-by-default "Permalink") 對于默認情況下禁用的功能，如果由于缺乏完整性而無法使用它們，或者仍在內部評估中（例如，出于性能方面的考慮），請**不要對其進行文檔化** ：僅在以下情況下添加（或合并）文檔：該功能是安全的，可供最終用戶使用和測試. 對于默認情況下禁用的功能標志，如果最終用戶可以使用它們： * 說默認情況下它是禁用的. * 說是否在 GitLab.com 上啟用了它. * 說說是否可以針對每個項目啟用或禁用它. * 說出是否建議將其用于生產. * 記錄如何啟用和禁用它. 例如，對于默認情況下禁用的功能，可以在每個項目上啟用或禁用 GitLab.com 上禁用的功能，并且不準備用于生產環境： ``` # Feature Name > - [Introduced](link-to-issue) in GitLab 12.0. > - It's deployed behind a feature flag, disabled by default. > - It's disabled on GitLab.com. > - It's able to be enabled or disabled per-project > - It's not recommended for production use. > - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#anchor-to-section). **(CORE ONLY)** (...) ### Enable or disable <Feature Name> **(CORE ONLY)** <Feature Name> is under development and not ready for production use. It is deployed behind a feature flag that is **disabled by default**. [GitLab administrators with access to the GitLab Rails console](../path/to/administration/feature_flags.md) can enable it for your instance. <Feature Name> can be enabled or disabled per-project To enable it: ```ruby # Instance-wide Feature.enable(:<feature flag>) # or by project Feature.enable(:<feature flag>, Project.find(<project id>)) ``` To disable it: ```ruby # Instance-wide Feature.disable(:<feature flag>) # or by project Feature.disable(:<feature flag>, Project.find(<project id>)) ``` ``` 根據要記錄的功能的狀態來調整 Blur. ### Features that became enabled by default[](#features-that-became-enabled-by-default "Permalink") 對于默認啟用的功能： * 假設默認情況下已啟用它. * 說是否在 GitLab.com 上啟用了它. * 說說是否可以針對每個項目啟用或禁用它. * 說出是否建議將其用于生產. * 記錄如何禁用和啟用它. 例如，對于最初部署時默認情況下禁用的功能，默認情況下已啟用，在 GitLab.com 上啟用了該功能，該功能無法按項目啟用或禁用，并且可以用于生產環境： ``` # Feature Name > - [Introduced](link-to-issue) in GitLab 12.0. > - It was deployed behind a feature flag, disabled by default. > - [Became enabled by default](link-to-issue) on GitLab 12.1. > - It's enabled on GitLab.com. > - It's not able to be enabled or disabled per-project > - It's recommended for production use. > - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)** (...) ### Enable or disable <Feature Name> **(CORE ONLY)** <Feature Name> is under development but ready for production use. It is deployed behind a feature flag that is **enabled by default**. [GitLab administrators with access to the GitLab Rails console](..path/to/administration/feature_flags.md) can opt to disable it for your instance it cannot be enabled or disabled per-project. To disable it: ```ruby Feature.disable(:<feature flag>) ``` To enable it: ```ruby Feature.enable(:<feature flag>) ``` ``` 根據要記錄的功能的狀態來調整 Blur. ### Features directly enabled by default[](#features-directly-enabled-by-default "Permalink") 對于默認啟用的功能： * 說默認情況下已啟用. * 說是否在 GitLab.com 上啟用了它. * 說說是否可以針對每個項目啟用或禁用它. * 說出是否建議將其用于生產. * 記錄如何禁用和啟用它. For example, for a feature enabled by default, enabled on GitLab.com, cannot be enabled or disabled per-project, and ready for production use: ``` # Feature Name > - [Introduced](link-to-issue) in GitLab 12.0. > - It's deployed behind a feature flag, enabled by default. > - It's enabled on GitLab.com. > - It's not able to be enabled or disabled per-project > - It's recommended for production use. > - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#anchor-to-section). **(CORE ONLY)** (...) ### Enable or disable <Feature Name> **(CORE ONLY)** <Feature Name> is under development but ready for production use. It is deployed behind a feature flag that is **enabled by default**. [GitLab administrators with access to the GitLab Rails console](..path/to/administration/feature_flags.md) can opt to disable it for your instance. To disable it: ```ruby Feature.disable(:<feature flag>) ``` To enable it: ```ruby Feature.enable(:<feature flag>) ``` ``` 根據要記錄的功能的狀態來調整 Blur. ### Features with flag removed[](#features-with-flag-removed "Permalink") 功能準備就緒并且標記已刪除后，請清理文檔. 刪除功能標記的提及，只保留一個在版本歷史記錄注釋中提及該標記的注釋： ``` # Feature Name > - [Introduced](link-to-issue) in GitLab 12.0. > - [Feature flag removed](link-to-issue) in GitLab 12.2. (...) ```