피처 플래그 뒤에 배포된 문서 기능

GitLab은 피처 플래그를 사용하여 고유한 기능을 배포합니다.

피처 플래그의 상태가 변경될 때 변경한 개발자는 반드시 문서를 업데이트해야 합니다.

피처 플래그 뒤에 문서화해야 하는 시점

비활성화된 피처 플래그 뒤에 있는 기능도 포함하여 모든 코드베이스에 도입된 기능은 문서화해야 합니다. 자세한 정보는 이 결정에 이르게 된 토론을 참조하세요. 실험 또는 베타 기능은 일반적으로 피처 플래그 뒤에 있으며 문서화해야 합니다. 자세한 정보는 실험 또는 베타 기능 문서화를 참조하세요.

기능이 여러 Merge Request에서 구현될 때, 기술 문서 작성자와 계획을 논의하세요.

기능:

- 많은 GitLab 영역에서 변경 사항을 가지고 있을 때(예: 탐색 변경), - 여러 Merge Request을 포함할 때, - 몇 개 이상의 문서 페이지에 영향을 미칠 때, - 피처 플래그가 테스트를 위해 활성화되어도 완전히 기능이 작동하지 않을 때,

문서 문제를 만들고 문서를 지연시킬 수 있습니다.

PM, EM, 및 기술 문서 작성자는 문서 작업이 할당되고 예정되도록 해야 합니다.

코드베이스의 모든 피처 플래그는 문서화되어 있으며, 해당 기능이 완전히 기능하지 않거나 다른 방식으로 문서화되어 있지 않더라도 해당합니다.

피처 플래그 문서 추가 방법

피처 플래그를 문서화하려면 다음을 해야 합니다:

기록 텍스트 추가

피처 플래그의 상태가 변경될 때(예: 기본적으로 비활성화에서 기본적으로 활성화로 변경될 때), 해당 변경을 기록에 추가하세요.

가능한 기록 항목은 다음과 같습니다: 

> - [GitLab X.X에서 소개됨](이슈 링크) - `flag_name`이라는 이름의 [플래그](../../administration/feature_flags.md)와 함께. 기본적으로 비활성화됨.
> - GitLab X.X에서 GitLab.com에서 활성화됨](이슈 링크). 
> - GitLab X.X에서 GitLab.com에서 활성화됨. GitLab.com 관리자만 사용 가능합니다.
> - GitLab X.X에서 GitLab.com에서 활성화됨.
> - GitLab X.Y에서 일반적으로 사용 가능하게 됨. `flag_name` 플래그가 제거되었습니다.

피처 플래그 상태를 설명하는 노트를 사용

피처 플래그에 대한 정보는 주제 시작 부분에 FLAG 노트에 있어야 합니다(기록 바로 아래에).

노트에는 세 부분이 있으며, 다음 구조를 따릅니다: 

FLAG:
<Self-managed GitLab의 이용 가능한 정보.>
<GitLab.com 이용 가능한 정보.>
<GitLab Dedicated 이용 가능한 정보.>
<이 기능은 프로덕션 사용에 준비되지 않았습니다.>

FLAG 노트는 GitLab 문서 사이트에서 다음과 같이 렌더링됩니다:

Self-managed되는 GitLab에서는 기본적으로 이 기능을 사용할 수 없습니다. 사용하려면 관리자가 example_flag라는 피처 플래그를 활성화해야 합니다. GitLab.com 및 GitLab Dedicated에서는 이 기능을 사용할 수 없습니다. 이 기능은 프로덕션 사용에 준비되지 않았습니다.

GitLab Dedicated 가용성 정보

기능 상태 해당 텍스트
사용 가능 GitLab Dedicated에서 이 기능을 사용할 수 있습니다.
사용 불가 GitLab Dedicated에서 이 기능을 사용할 수 없습니다.
  • 다음과 같이 GitLab.com과 GitLab Dedicated를 결합할 수 있습니다: GitLab.com 및 GitLab Dedicated에서 이 기능을 사용할 수 없습니다.
  • 기능이 Self-managed에 대한 비활성화된 피처 플래그 뒤에 숨겨져 있는 경우, 해당 기능은 GitLab Dedicated에서 사용할 수 없습니다.

선택 사항 정보

필요한 경우 다음 문구를 추가할 수 있습니다:

이 기능은 프로덕션 환경에 사용할 준비가 되지 않았습니다.

피처 플래그 문서 예시

다음 예시에서는 피처 플래그의 진행을 보여줍니다. 

> - GitLab 13.7에서 [플래그](../../administration/feature_flags.md)인 `forti_token_cloud`로 소개되었으며 기본적으로 비활성화되었습니다.

플래그:
Self-managed GitLab에서는 기본적으로 이 기능을 사용할 수 없습니다. 사용할 수 있도록 하려면, 관리자는 `forti_token_cloud`로 명명된 피처 플래그를 [활성화](../administration/feature_flags.md)할 수 있습니다. 이 기능은 프로덕션 환경에 사용할 준비가 되지 않았습니다. GitLab.com 및 GitLab Dedicated에서 이 기능을 사용할 수 없습니다.

기능이 프로덕션에서 활성화된 경우, 히스토리를 업데이트할 수 있습니다: 

> - GitLab 13.7에서 [플래그](../../administration/feature_flags.md)인 `forti_token_cloud`로 소개되었으며 기본적으로 비활성화되었습니다.
> - [Self-managed GitLab에서 활성화됨](https://gitlab.com/issue/etc) GitLab 13.8.

플래그:
Self-managed GitLab에서는 기본적으로 이 기능을 사용할 수 있습니다. 사용자별로 기능을 숨기려면, 관리자는 `forti_token_cloud`로 명명된 피처 플래그를 [비활성화](../administration/feature_flags.md)할 수 있습니다. GitLab.com 및 GitLab Dedicated에서 이 기능을 사용할 수 있습니다.

그리고, 기능이 모든 사용자에게 완전히 사용 가능해지면: 

> - GitLab 13.7에서 [플래그](../../administration/feature_flags.md)인 `forti_token_cloud`로 소개되었으며 기본적으로 비활성화되었습니다.
> - [Self-managed에서 활성화됨](https://gitlab.com/issue/etc) GitLab 13.8.
> - [GitLab.com에서 활성화됨](https://gitlab.com/issue/etc) GitLab 13.9.
> - [일반적으로 사용 가능](issue-link) GitLab 14.0. 피처 플래그 `forti_token_cloud` 제거됨.

긴 히스토리 간소화

히스토리가 길어지지만, 때로는 간소화하거나 항목을 제거할 수 있습니다.

같은 릴리스에서 발생한 경우 항목을 결합할 수 있습니다:

  • 이전: 

    > - GitLab 14.2에서 [소개함](issue-link) [플래그](../../administration/feature_flags.md)인 `ci_include_rules`명으로. 기본적으로 비활성화되었습니다.
> - GitLab 14.3에서 [GitLab.com에서 활성화됨](issue-link).
> - GitLab 14.3에서 [Self-managed에서 활성화됨](issue-link).
> - GitLab 14.3에서 [GitLab Dedicated에서 활성화됨](issue-link).

  • 이후: 

    > - GitLab 14.2에서 [플래그](../../administration/feature_flags.md)인 `ci_include_rules`로 소개되었으며 기본적으로 비활성화되었습니다.
> - GitLab 14.3에서 [GitLab.com, Self-managed, 및 GitLab Dedicated에서 활성화됨](issue-link).

기능이 모든 제공에 대해 기본적으로 활성화된 경우 GitLab.com에서 활성화됨 항목을 제거합니다:

  • 이전: 

    > - GitLab 15.6에서 [소개함](issue-link) [플래그](../../administration/feature_flags.md)인 `ci_hooks_pre_get_sources_script`명으로. 기본적으로 비활성화되었습니다.
> - GitLab 15.9에서 [GitLab.com에서 활성화됨](issue-link).
> - GitLab 15.10에서 [일반적으로 사용 가능](issue-link). 피처 플래그 `ci_hooks_pre_get_sources_script` 제거됨.

  • 이후: 

    > - GitLab 15.6에서 [플래그](../../administration/feature_flags.md)인 `ci_hooks_pre_get_sources_script`로 소개되었으며 기본적으로 비활성화되었습니다.
> - GitLab 15.10에서 [일반적으로 사용 가능](issue-link). 피처 플래그 `ci_hooks_pre_get_sources_script` 제거됨.