실험 및 베타 기능 문서화
GitLab v19.1실험 또는 베타 기능을 문서화할 때: 제품 가용성 세부 정보에 상태를 포함하세요. 기능 플래그 뒤에 있는 경우 기능 플래그 세부 정보를 포함하세요. 기능 상태가 변경되면 기능 상태를 업데이트하세요. 네임스페이스 설정의 실험 및 베타 기능 사용 토글은 GitLab Duo 기능에만 해당됩니다.
실험 또는 베타 기능을 문서화할 때:
-
제품 가용성 세부 정보에 상태를 포함하세요.
-
기능 플래그 뒤에 있는 경우 기능 플래그 세부 정보를 포함하세요.
-
기능 상태가 변경되면 기능 상태를 업데이트하세요.
실험 및 베타 기능 토글#
네임스페이스 설정의 실험 및 베타 기능 사용 토글은 GitLab Duo 기능에만 해당됩니다. 이 설정은 AI/GitLab Duo 이외의 실험 또는 베타 기능에는 사용하지 않아야 합니다.
GitLab Duo가 아닌 실험 및 베타 기능의 경우:
-
해당 기능에 적합한 기능별 토글 또는 기능 플래그를 사용하세요.
-
네임스페이스 수준의 실험 및 베타 설정에 기능을 연결하지 마세요.
-
해당 기능의 고유한 문서에 기능 제어 방법을 문서화하세요.
GitLab 인스턴스 유형별 설정#
GitLab 인스턴스 유형에 따라 GitLab Duo의 실험 및 베타 기능을 제어하는 두 가지 설정이 있습니다:
-
GitLab.com: 최상위 네임스페이스 설정
experiment_features_enabled를 사용합니다. 이는 네임스페이스 수준의 설정으로, 각 최상위 그룹이 해당 네임스페이스에 대해 실험 및 베타 GitLab Duo 기능의 활성화 여부를 제어할 수 있습니다. -
GitLab Self-Managed 및 GitLab Dedicated: 인스턴스 수준 설정
instance_level_ai_beta_features_enabled를 사용합니다. 이는 관리자가 제어하며 인스턴스의 모든 네임스페이스에 적용되는 인스턴스 전체 설정입니다.
GitLab Duo 기능을 구현할 때:
-
인스턴스 유형에 따라 적절한 설정을 확인하세요.
-
GitLab.com에서는 네임스페이스의
experiment_features_enabled설정을 확인하세요. -
Self-Managed 및 Dedicated 인스턴스에서는
instance_level_ai_beta_features_enabled설정을 확인하세요. -
이 설정들을 혼용하거나 두 설정을 모두 확인하지 마세요. 각 인스턴스 유형은 해당하는 설정만 사용해야 합니다.
구현 예시는 ee/lib/gitlab/llm/stage_check.rb를 참조하세요.
기능이 일반 사용 가능(GA) 상태가 될 때#
기능이 실험 또는 베타에서 일반 사용 가능 상태로 변경될 때:
-
제품 가용성 세부 정보에서 **상태(Status)**를 제거하세요.
-
기능이 프로덕션 사용에 준비되지 않았다는 내용의 문구를 제거하세요.
-
히스토리를 업데이트하세요.
사용자 등록 또는 피드백이 필요한 기능#
사용자가 등록하거나 피드백을 남기는 방법에 대한 세부 정보를 포함하려면,
type=flag 알림 아래에 추가하세요.
예시:
## Great new feature
<details class="history-toggle"><summary>히스토리</summary><ul><li><a href="https://issue-link">Introduced</a> in GitLab 15.10. This feature is an <a href="<link_to>/policy/development_stages_support.md">experiment</a>.</li></ul></details>
<div class="admonition tip"><div class="admonition-title">Feature flag</div>
The availability of this feature is controlled by a feature flag.
For more information, see the history.
This feature is available for testing, but not ready for production use.
</div>
Use this new feature when you need to do this new thing.
This feature is an [experiment](<link_to>/policy/development_stages_support.md).
To test this feature, do this thing or contact these people.
Share your feedback in [issue 12345](https://link).
GitLab Duo 기능#
GitLab Duo 기능을 문서화할 때 다음 지침을 따르세요.
실험(Experiment)#
GitLab Duo 실험 기능을 문서화할 때:
테이블에 행을 추가하세요.
-
소프트웨어 개발 수명 주기의 유사한 Stage에서 사용 가능한 다른 기능 근처, 페이지 상단 영역에 기능을 추가하세요.
-
유사한 다른 기능 근처에 기능을 문서화하세요.
-
애드온 정보를 포함하여 히스토리 및 상태 값을 반드시 추가하세요.
베타(Beta)#
GitLab Duo 실험 기능이 베타로 전환될 때:
-
GitLab Duo 기능 요약 페이지에서 테이블의 행을 업데이트하세요.
-
애드온 정보를 포함하여 히스토리 및 상태 값을 반드시 업데이트하세요.
일반 사용 가능(Generally available)#
GitLab Duo 기능이 일반 사용 가능 상태가 될 때:
-
GitLab Duo 기능 요약 페이지에서 기능을 GA 테이블로 이동하세요.
-
애드온 정보를 포함하여 히스토리 및 상태 값을 반드시 업데이트하세요.