Document features deployed behind feature flags

Document features deployed behind feature flags

manbetx 客户端打不开使用功能标志来战略性地推出自己的功能的部署. 我们在功能标记后面记录功能的方式取决于其状态（启用或禁用）. 状态更改时，进行更改的开发人员必须相应地更新文档 .

根据的过程：

根据标志的状态，请参阅下面的文档说明：

注意：功能级别的徽标或等效标记应添加到以下行和标题中，即启用/禁用功能标志，因为这样做需要管理员访问权限，因此，它表示不能由 GitLab.com 的普通用户完成.

对于默认情况下禁用的功能，如果由于缺乏完整性而无法使用它们，或者仍在内部评估中（例如，出于性能方面的考虑），请不要对其进行文档化 ：仅在以下情况下添加（或合并）文档：该功能是安全的，可供最终用户使用和测试.

  • 说默认情况下它是禁用的.
  • 说是否在 GitLab.com 上启用了它.
  • 说说是否可以针对每个项目启用或禁用它.
  • 记录如何启用和禁用它.

例如，对于默认情况下禁用的功能，可以在每个项目上启用或禁用 GitLab.com 上禁用的功能，并且不准备用于生产环境：

To disable it:

```ruby # Instance-wide Feature.disable(:)

or by project

Feature.disable(:, Project.find())

  1. ```
  3. 根据要记录的功能的状态来调整 Blur.
  5. ### Features that became enabled by default[](#features-that-became-enabled-by-default "Permalink")
  7. 对于默认启用的功能：
  9. *   假设默认情况下已启用它.
  10. *   说是否在 GitLab.com 上启用了它.
  11. *   说说是否可以针对每个项目启用或禁用它.
  13. *   记录如何禁用和启用它.
  15. 例如，对于最初部署时默认情况下禁用的功能，默认情况下已启用，在 GitLab.com 上启用了该功能，该功能无法按项目启用或禁用，并且可以用于生产环境：

Feature Name

(…)

To disable it:

```ruby Feature.disable(:)

  3. ### Features directly enabled by default[](#features-directly-enabled-by-default "Permalink")
  5. 对于默认启用的功能：
  7. *   说默认情况下已启用.
  9. *   说说是否可以针对每个项目启用或禁用它.
  10. *   说出是否建议将其用于生产.
  11. *   记录如何禁用和启用它.
  13. 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

(…)

is under development but ready for production use. It is deployed behind a feature flag that is enabled by default. can opt to disable it for your instance.

To disable it:

  2. 根据要记录的功能的状态来调整 Blur.
  4. ### Features with flag removed[](#features-with-flag-removed "Permalink")
  6. 功能准备就绪并且标记已删除后，请清理文档. 删除功能标记的提及，只保留一个在版本历史记录注释中提及该标记的注释：

Feature Name

(…) ```