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

GitLab은 기능 플래그를 사용하여 자체 기능의 배포를 수행합니다.

기능 플래그의 상태가 변경되면, 변경을 수행한 개발자는 문서를 업데이트해야 합니다.

기능 플래그 뒤에 있는 기능을 문서화할 때

비활성 플래그 뒤에 있더라도 코드베이스에 도입된 모든 기능은 문서화되어야 합니다. 자세한 내용은 이 결정을 내리는 과정에서의 논의를 참조하세요. 실험 및 베타 기능은 일반적으로 플래그 뒤에 있으며 문서화되어야 합니다. 자세한 내용은 실험 또는 베타 기능 문서화를 참조하세요.

기능이 여러 병합 요청에서 구현된 경우, 기술 문서 작성자와 계획에 대해 논의하세요.

기능이 다음과 같은 경우에는 문서화 문제를 생성하고 지연시킬 수 있습니다:

  • 광범위하게 영향을 미치는 경우(많은 GitLab 영역에서 변경됨), 예를 들어 내비게이션 변경.
  • 많은 MRs을 포함하는 경우.
  • 몇 개 이상의 문서 페이지에 영향을 미치는 경우.
  • 기능 플래그가 테스트용으로 활성화된 경우 완전히 기능적이지 않은 경우.

PM, EM 및 작성자는 문서 작업이 지정되고 일정이 잡히도록 해야 합니다.

코드베이스의 모든 기능 플래그는 문서화되어 있습니다, 기능이 완전히 작동하지 않거나 다른 방법으로 문서화되지 않은 경우에도 마찬가지입니다.

기능 플래그 문서 추가 방법

기능 플래그를 문서화하려면:

Offerings

Offerings를 문서화할 때, 자체 관리에서 비활성화된 기능에 대해서는 GitLab Dedicated를 기능의 제공 항목으로 나열하지 마세요.

히스토리 텍스트 추가

플래그의 상태가 변경될 때(예: 기본적으로 비활성에서 기본적으로 활성으로), 해당 변경 사항을 히스토리에 추가하세요.

가능한 히스토리 항목은 다음과 같습니다:

> - [도입됨](https://issue-link) GitLab X.X [의 플래그와 함께](../../administration/feature_flags.md) `flag_name`으로. 기본적으로 비활성화됨.
> - [GitLab.com에서 활성화됨](https://issue-link) GitLab X.X.
> - [자체 관리 및 GitLab Dedicated에서 활성화됨](https://issue-link) GitLab X.X.
> - [GitLab.com, 자체 관리 및 GitLab Dedicated에서 활성화됨](https://issue-link) GitLab X.X.
> - [일반 사용 가능](https://issue-link) GitLab X.Y. 기능 플래그 `flag_name`이 제거됨.

이 항목들이 모든 시나리오에 맞지 않을 수 있습니다. 필요에 따라 조정할 수 있습니다. 예를 들어, 플래그가 그룹, 프로젝트 또는 사용자 하위 집합에 대해서만 활성화된 경우 다음과 같은 히스토리 항목을 사용할 수 있습니다:

> - [GitLab.com에서 활성화됨](https://issue-link) GitLab X.X 사용자 하위 집합에 대해.

플래그 노트 추가

해당 주제의 시작 부분, 즉 히스토리 아래에 이 기능 플래그 노트를 추가하세요.

마지막 문장(프로덕션 사용 준비가 되지 않음)은 선택 사항입니다.

FLAG:
이 기능의 사용 가능성은 기능 플래그에 의해 제어됩니다.
자세한 내용은 히스토리를 참조하세요.
이 기능은 테스트 용도로 사용 가능하지만 프로덕션 사용 준비가 되지 않았습니다.

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

이 기능의 사용 가능성은 기능 플래그에 의해 제어됩니다. 자세한 내용은 히스토리를 참조하세요. 이 기능은 테스트 용도로 사용 가능하지만 프로덕션 사용 준비가 되지 않았습니다.

역사 예시

다음 예시는 기능 플래그의 진행 상황을 보여줍니다. 변경 사항이 있을 때마다 이력을 업데이트하세요:

> - [도입됨](https://issue-link) GitLab 13.7 [에서 플래그와 함께](../../administration/feature_flags.md) 이름 `forti_token_cloud`. 기본적으로 비활성화되어 있습니다.

FLAG:
이 기능의 사용 가능성은 기능 플래그에 의해 제어됩니다. 더 많은 정보는 이력을 참조하세요.

기능이 GitLab.com에서 기본적으로 활성화된 경우:

> - [도입됨](https://issue-link) GitLab 13.7 [에서 플래그와 함께](../../administration/feature_flags.md) 이름 `forti_token_cloud`. 기본적으로 비활성화되어 있습니다.
> - [GitLab.com에서 활성화됨](https://issue-link) GitLab 13.8.

FLAG:
이 기능의 사용 가능성은 기능 플래그에 의해 제어됩니다. 더 많은 정보는 이력을 참조하세요.

기능이 모든 제공 사항에 대해 기본적으로 활성화된 경우:

> - [도입됨](https://issue-link) GitLab 13.7 [에서 플래그와 함께](../../administration/feature_flags.md) 이름 `forti_token_cloud`. 기본적으로 비활성화되어 있습니다.
> - [GitLab.com에서 활성화됨](https://issue-link) GitLab 13.8.
> - [자체 관리 및 GitLab 전용에서 활성화됨](https://issue-link) GitLab 13.9.

FLAG:
이 기능의 사용 가능성은 기능 플래그에 의해 제어됩니다. 더 많은 정보는 이력을 참조하세요.

플래그가 제거될 때, 일반적으로 사용 가능 항목을 추가하세요. FLAG 메모를 삭제하세요:

> - [도입됨](https://issue-link) GitLab 13.7 [에서 플래그와 함께](../../administration/feature_flags.md) 이름 `forti_token_cloud`. 기본적으로 비활성화되어 있습니다.
> - [GitLab.com에서 활성화됨](https://issue-link) GitLab 13.8.
> - [자체 관리 및 GitLab 전용에서 활성화됨](https://issue-link) GitLab 13.9.
> - [일반적으로 사용 가능](https://issue-link) GitLab 14.0. 기능 플래그 `forti_token_cloud`가 제거되었습니다.

긴 이력 단순화

이력이 길어질 수 있지만 때때로 항목을 단순화하거나 삭제할 수 있습니다.

같은 릴리스에서 발생한 항목을 결합하세요:

  • 이전:

    > - [도입됨](https://issue-link) GitLab 14.2 [에서 플래그와 함께](../../administration/feature_flags.md) 이름 `ci_include_rules`. 기본적으로 비활성화되어 있습니다.
> - [GitLab.com에서 활성화됨](https://issue-link) GitLab 14.3.
> - [자체 관리 및 GitLab 전용에서 활성화됨](https://issue-link) GitLab 14.3.

  • 이후:

    > - [도입됨](https://issue-link) GitLab 14.2 [에서 플래그와 함께](../../administration/feature_flags.md) 이름 `ci_include_rules`. 기본적으로 비활성화되어 있습니다.
> - [GitLab.com, 자체 관리 및 GitLab 전용에서 활성화됨](https://issue-link) GitLab 14.3.

기능이 모든 제공 사항에 대해 기본적으로 활성화되고 플래그가 제거된 경우에만 GitLab.com에서 활성화됨 항목을 삭제하세요:

  • 이전:

    > - [도입됨](https://issue-link) GitLab 15.6 [에서 플래그와 함께](../../administration/feature_flags.md) 이름 `ci_hooks_pre_get_sources_script`. 기본적으로 비활성화되어 있습니다.
> - [GitLab.com에서 활성화됨](https://issue-link) GitLab 15.7.
> - [자체 관리 및 GitLab 전용에서 활성화됨](https://issue-link) GitLab 15.8.
> - [일반적으로 사용 가능](https://issue-link) GitLab 15.9. 기능 플래그 `ci_hooks_pre_get_sources_script`가 제거되었습니다.

  • 이후:

    > - [도입됨](https://issue-link) GitLab 15.6 [에서 플래그와 함께](../../administration/feature_flags.md) 이름 `ci_hooks_pre_get_sources_script`. 기본적으로 비활성화되어 있습니다.
> - [자체 관리 및 GitLab 전용에서 활성화됨](https://issue-link) GitLab 15.8.
> - [일반적으로 사용 가능](https://issue-link) GitLab 15.9. 기능 플래그 `ci_hooks_pre_get_sources_script`가 제거되었습니다.