제품 버전 문서화
GitLab 제품 문서에는 버전별 정보가 포함되어 있으며, 기능의 도입, 업데이트 또는 제거 시기가 포함됩니다.
이전 문서 버전 보기
문서의 이전 버전은 docs.gitlab.com에서 사용할 수 있습니다. 이전 버전을 보려면 오른쪽 상단에서 버전을 선택하세요.
docs.gitlab.com에서 사용할 수 없는 버전을 보려면:
버전별 기능 문서화
기능이 추가되거나 업데이트된 경우, History 디렉터리 항목으로나 인라인 텍스트 참조로 문서를 업데이트하세요.
/development 디렉터리의 페이지에는 과거 정보를 추가할 필요가 없습니다.
History 항목 추가
토픽의 모든 콘텐츠가 관련된 경우, 토픽 제목 다음에 history 항목을 추가하세요. 예를 들어:
## 기능 이름
> - [도입됨](<이슈-링크>) GitLab 11.3에서.
이 기능은 무언가를 수행합니다.
항목 텍스트에는 다음 단어가 순서대로 포함되어야 합니다. 대소문자는 중요하지 않습니다.
-
introduced,enabled,deprecated,changed,moved,recommended,removed, 또는renamed -
in또는to -
GitLab(또는 외부 프로젝트인 경우 프로젝트 이름)
문서 사이트는 Ruby 코드를 사용하여 이러한 단어를 기반으로 노트를 렌더링합니다.
추가로:
- 페이지의 다른 노트나 문서 사이트의 다른 노트와 일관성을 유지하세요.
- 출력이 올바르게 생성되는지 확인하세요.
- 가능하면 관련된 이슈, Merge Request 또는 에픽에 대한 링크를 포함하세요.
- 요금 페이지에 링크하지 마세요. 구독 계층을 포함하지 마세요.
- 하나의 항목만 있는 경우라도
> -로 시작되도록 확인하세요.
기능 업데이트 문서화
기능이 변경되거나 업데이트된 경우, 새로운 디렉터리 항목을 추가하세요. 문장을 기능 이름이나 동명사로 시작하세요.
예를 들어, 이슈 보드 페이지의 경우:
> - [도입됨](<이슈-링크>) GitLab 13.1에서.
> - 이슈 보드에서 이슈 생성이 [도입됨](<이슈-링크>) GitLab 14.1에서.
또는 이메일 알림 페이지의 경우:
> - [도입됨](<이슈-링크>) GitLab 13.1에서.
> - 만료 토큰에 대한 알림이 [도입됨](<이슈-링크>) GitLab 14.3에서.
구독 계층 이동
기능이 다른 구독 계층으로 이동된 경우 moved를 사용하세요:
> - GitLab Ultimate에서 GitLab Premium으로 [이동됨](<이슈-링크>) 11.8에서.
> - GitLab Premium에서 GitLab Free으로 [이동됨](<이슈-링크>) 12.0에서.
기능 상태 변경
기능 상태가 실험 또는 베타로 변경된 경우 changed를 사용하세요:
> - GitLab 15.7에서 [실험](../../policy/experiment-beta-support.md)으로 [도입됨](<이슈-링크>).
> - GitLab 16.0에서 베타로 [변경됨](<이슈-링크>).
일반적으로 사용할 수 있는 변경인 경우:
> - GitLab 16.10에서 [일반적으로 사용 가능](이슈-링크).
피처 플래그로 도입된 기능
기능이 플래그 뒤에 도입된 경우, 플래그에 관한 세부 정보를 문서에 추가해야 합니다. 자세한 내용은 플래그로 배포된 기능 문서화를 참조하세요.
인라인 history 텍스트
기존 토픽에 콘텐츠를 추가하는 경우, 기존 텍스트와 인라인으로 역사 정보를 추가할 수 있습니다. 가능하면 관련 이슈, Merge Request 또는 에픽에 링크를 포함하세요. 예를 들어:
투표 전략은 [GitLab 13.4 이후](<이슈-링크>)에 기본 및 보조 투표자의 동의를 요구합니다.
사용 중지 및 제거
기능이 사용 중지되거나 제거된 경우 관련 문서를 업데이트하세요.
페이지 또는 토픽 사용 중지
페이지 또는 토픽을 사용 중지하려면:
-
제목 뒤에
(deprecated)을 추가하세요. 사용 중지된 날짜, 제거 예정일 및 대체 기능을 설명하는 경고를 사용하세요.## 제목 (deprecated) DETAILS: **Tier:** Premium, Ultimate **Offering:** GitLab.com, Self-Managed, GitLab Dedicated WARNING: 이 기능은 GitLab 14.8에서 [사용 중지되었으며](<이슈-링크>) 15.4에서 제거될 예정입니다. [feature X](<링크-문서>)를 대신 사용하세요.기능이 언제 제거될지 확실하지 않거나 대체 기능이 없는 경우, 이 정보를 추가할 필요가 없습니다.
-
사용 중지가 breaking change인 경우, 다음 텍스트를 추가하세요:
이 변경은 breaking change입니다.사용자가 도움이 될 수 있는 추가 컨텍스트별 세부 정보를 추가할 수 있습니다.
-
내용 위와 아래에 다음 HTML 주석을 추가하세요.
remove_date에는 제거 예정 버전에서 3개월 후의 날짜를 설정하세요.<!--- start_remove 다음 콘텐츠는 remove_date: 'YYYY-MM-DD'에 제거될 예정입니다 --> ## 제목 (deprecated) DETAILS: **Tier:** Premium, Ultimate **Offering:** GitLab.com, Self-Managed, GitLab Dedicated WARNING: 이 기능은 GitLab 14.8에서 [사용 중지되었으며](<이슈-링크>) 15.4에서 제거될 예정입니다. [feature X](<링크-문서>)를 대신 사용하세요. <!--- end_remove --> -
단어
(deprecated)을 페이지 제목 뒤의 좌측 탐색에 추가하려면 Merge Request을 엽니다.
페이지 제거
기능이 제거된 상태의 릴리스에서 콘텐츠를 제거합니다. 제목과 제거된 표시만 제거될 예정일로부터 3개월 후까지 남습니다.
페이지를 제거하려면:
- 페이지 제목을 남겨둡니다. 이외의 모든 콘텐츠, 히스토리 항목 및 경고 단어를 제거하세요.
- 제목 뒤에
(deprecated)를(removed)로 변경하세요. - YAML 메타데이터를 업데이트하세요:
-
remove_date에는 기능이 제거된 릴리스로부터 3개월 후의 날짜를 설정하세요. -
redirect_to에 적절한 파일 경로를 설정하세요. 명확한 페이지가 없는 경우 문서 홈페이지를 사용하세요.
--- stage: Data Stores group: Global Search info: 이 페이지와 관련된 단계/그룹에 지정된 기술 작성자를 확인하려면 https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments에서 확인하세요. remove_date: '2022-08-02' redirect_to: '../newpath/to/file/index.md' --- # 제목 (removed) DETAILS: **Tier:** Premium, Ultimate **Offering:** GitLab.com, Self-Managed, GitLab Dedicated 이 기능은 GitLab X.Y에서 [사용 중지되었으며](<이슈-링크>) [제거되었습니다](<이슈-링크>). [feature X](<링크-문서>)를 대신 사용하세요. -
- 글로벌 내비게이션에서 페이지 항목을 제거하려면
gitlab-docs의navigation.yaml를 편집하세요.
이 내용은 정기적으로 예정된 작업의 일환으로 문서에서 제거됩니다.
Remove a topic (removed)
This feature was deprecated in GitLab X.Y and removed in X.Y. Use feature X instead.
이 내용은 기술 문서 팀의 정기적인 예정 작업의 일환으로 문서에서 제거되었습니다.
제거된 버전
GitLab은 현재 주요 버전 및 이전 두 개의 주요 버전을 지원합니다. 예를 들어, 16.0이 현재 주요 버전인 경우, GitLab 16.0, 15.0 및 14.0의 모든 주요 및 마이너 버전 릴리스가 지원됩니다.
지원되지 않는 버전을 참조하는 히스토리 항목이나 인라인 텍스트가 있는 경우 제거할 수 있습니다.
히스토리에서 피처 플래그 뒤의 기능에 대한 정보를 삭제하려면 해당 피처 플래그와 관련된 모든 이벤트가 지원되지 않는 버전에서 발생한 경우에만 삭제하십시오. 플래그가 아직 제거되지 않았다면 독자들은 해당 플래그가 도입된 시기를 알아야 합니다.
과거의 기능 정보는 릴리스 포스트에서 사용할 수 있으며 작업이 수행된 이슈 또는 머지 요청을 검색하여 찾을 수 있습니다.
제거 타이밍
새로운 주요 버전이 곧 릴리스 될 때, 마지막으로 지원되지 않는 버전에 대한 언급을 제거하기 위한 Merge Request를 생성할 수 있지만, 이러한 리퀘스트는 새로운 주요 릴리스의 마일스톤 중에만 Merge해야 합니다.
예를 들어, GitLab 17.0이 새로운 주요 버전인 경우:
- 지원되는 버전은 16, 15, 14입니다.
- GitLab 17.0이 릴리스되었을 때, GitLab 14가 더 이상 지원되지 않습니다.
그런 다음 GitLab 14에 대한 모든 언급을 삭제하기 위한 Merge Request를 생성할 수 있지만, 이러한 리퀘스트는 16.11이 릴리스된 후인 17.0 마일스톤에서만 Merge해야 합니다.
업그레이드 페이지의 예외
버전별 페이지는 이전 지침의 유일한 예외입니다.
예를 들어 doc/update/versions/14_changes.md은
.3 마일스톤에서 제거해야 합니다. 이 예에서 변경 사항은 17.3에서 제거됩니다.
우리는 사용자가 오래된 버전에서 업그레이드할 시간을 확보하기 위해 이러한 페이지를 즉시 제거하지 않습니다.
지원되지 않는 페이지를 제거하는 대신, 미래의 월간 유지 관리 작업의 일환으로 앞으로 3개월간의 날짜를 갖는 참고를 추가하십시오.
또한, X_changes.md 페이지가 버전 정리의 일환으로 제거된 다른 섹션에 대한 상대적 링크를 포함하는 경우,
docs-lint links 작업은 실패할 가능성이 높습니다. 이러한 상대적 링크를 아카이브된 버전으로 대체할 수 있습니다.
지원되지 않는 버전의 최신 마이너 버전을 선택하십시오. 예시는 다음을 참조하십시오.
https://archives.docs.gitlab.com/.
향후 버전에서 약속된 기능
향후 릴리스에서 기능을 제공할 예정임을 약속하거나 암시하지 마십시오. 예를 들어, “이 기능을 지원할 예정입니다.”와 같은 구문을 피하십시오.
우리는 미래의 기능 작업을 보장할 수 없으며 이러한 약속은 법적 문제를 야기할 수 있습니다. 대신, 해당 이슈가 존재한다고 말할 수 있습니다.
- 개선사항을 지원하는 [이슈
](LINK-TO-ISSUE)가 제안되었습니다. - 여러분은 이것을 할 수 없지만, 이슈 12345가 이 동작을 변경하도록 제안했습니다.
우리는 기능을 제거할 계획임을 밝힐 수 있습니다.
향후 기능에 대한 법적 면책 사항
만약 아직 제공하지 않은 기능에 대해 작성해야 할 경우, 해당 내용과 관련된 밑에 나오는 내용을 정확히 작성하십시오.
DISCLAIMER:
이 페이지에는 예정된 제품, 기능 및 기능과 관련된 정보가 포함되어 있습니다.
이 페이지에 있는 정보는 정보 제공을 목적으로만 제공되는 것이 중요합니다.
구매 또는 계획 목적으로 이 정보를 신뢰하지 마십시오.
제품, 기능 또는 기능의 개발, 릴리스 및 타이밍은 변경되거나 지연될 수 있으며
이는 GitLab Inc.의 전적인 재량에 따라 결정됩니다.
GitLab 문서 사이트에서는 다음과 같이 나타납니다:
만약 페이지의 모든 내용이 이용 불가능한 경우, 페이지 맨 위에 보다시피 앞으로 있는 내용에 관한 면책 사항을 한 번 작성하십시오.
만약 특정 주제 내용이 준비되지 않은 경우, 해당 주제에 면책 사항을 사용하십시오.
도움말