제품 버전 문서화

GitLab 제품 문서에는 버전별 정보가 포함되어 있으며, 기능이 도입된 날짜 및 업데이트 또는 제거된 날짜가 나와 있습니다.

이전 문서 버전 보기

문서의 이전 버전은 docs.gitlab.com에서 사용할 수 있습니다. 이전 버전을 보려면 오른쪽 상단에서 Versions를 선택하세요.

docs.gitlab.com에서 사용할 수 없는 버전을 보려면:

  • 문서 보관소를 확인하세요.
  • GitLab 저장소로 이동하여 버전별 브랜치를 선택하세요. 예를 들어, 13.2 브랜치에는 GitLab 13.2를 위한 문서가 있습니다.

버전별 기능 문서화

기능이 추가되거나 업데이트되면 History 목록 항목이나 인라인 텍스트 참조로 문서를 업데이트하세요.

/development 디렉터리의 페이지에는 과거 정보를 추가할 필요가 없습니다.

History 항목 추가

토픽의 모든 내용이 관련되는 경우 토픽 제목 뒤에 history 항목을 추가하세요. 예:

## 기능명

> - [GitLab 11.3에서 도입됨](<link-to-issue>).

이 기능은 이런 작업을 수행합니다.

항목 텍스트에는 다음 순서로 이러한 단어가 포함되어야 합니다. 대소문자는 중요하지 않습니다.

  • introduced, enabled, deprecated, changed, moved, recommended, removed, 또는 renamed
  • in 또는 to
  • GitLab (또는 외부 프로젝트의 경우 프로젝트 이름)

문서 사이트는 Ruby 코드를 사용하여 이러한 단어에 기반하여 노트를 렌더링합니다.

또한:

  • 페이지 또는 문서 사이트의 다른 노트와 일관성을 유지하려고 노력하세요.
  • 결과가 제대로 생성되도록 확인하세요.
  • 가능하면 관련된 이슈, 병합 요청 또는 에픽에 대한 링크를 포함하세요.
  • 가격 페이지에 링크를 걸지 마세요. 구독 계층을 포함하지 마세요.
  • 단 하나의 항목만 있는 경우라도 > -로 시작하도록 보장하세요.

새로운 기능 소개

introduced를 사용하는 경우 기능명이나 Gerund로 문장을 시작하세요:

> - 만료 토큰에 대한 알림 [GitLab 11.3에서 도입됨](<link-to-issue>).
> - 이슈 보드에서 이슈 생성 [GitLab 13.1에서 도입됨](<link-to-issue>).

구독 계층 이동

기능이 다른 구독 계층으로 이동하는 경우 moved를 사용하세요:

> - GitLab Ultimate에서 GitLab Premium으로 [이동](<link-to-issue>)됨 (11.8 버전).
> - GitLab Premium에서 GitLab Free로 [이동](<link-to-issue>)됨 (12.0 버전).

기능 상태 변경

기능 상태가 변경되는 경우 changed를 사용하세요:

> - [GitLab 15.7에서 [실험](../../policy/experiment-beta-support.md)으로 도입](<link-to-issue>).
> - GitLab 16.0 버전에서 Beta로 [변경](<link-to-issue>).
> - GitLab 16.3 버전에서 일반적으로 사용 가능하게 [변경](<link-to-issue>).

기능 플래그 뒤에 도입된 기능

기능이 플래그 뒤에 도입되면 플래그에 대한 세부 정보를 문서에 추가해야 합니다. 더 많은 정보는 플래그가 있는 기능을 문서화를 참조하세요.

인라인 history 텍스트

기존 토픽에 콘텐츠를 추가하는 경우, 기존 텍스트와 인라인으로 과거 정보를 추가할 수 있습니다. 가능하면 관련 이슈, 병합 요청 또는 에픽에 대한 링크를 포함하세요. 예:

투표 전략은 [GitLab 13.4 이후](<link-to-issue>)에 주요 표 및 보조 표가 동의해야 합니다.

폐기 및 제거

기능이 폐기되거나 제거되면 관련 문서를 업데이트하세요.

참고: GraphQL 문서에 대한 별도의 프로세스가 있으며 REST API 문서에 대한 별도의 프로세스가 있습니다.

페이지 또는 토픽 폐기

페이지 또는 토픽을 폐기하려면:

  1. 제목 뒤에 (폐기됨)을 추가하세요. 폐기된 날짜, 제거될 날짜 및 대체 기능을 설명하는 경고를 사용하세요.

    ## 제목 (폐기됨)
    
    세부 정보:
    **계층:** 프리미엄, 얼티밋
    **제공:** GitLab.com, 셀프매니지드, GitLab 전용
    
    경고:
    이 기능은 GitLab 14.8 버전에서 [폐기](<link-to-issue>)되었으며
    15.4 버전에서 제거될 예정입니다. 대신 [기능 X](<link-to-docs>)를 사용하세요.
    

    기능이 언제 제거될지 확실하지 않거나 대체 기능이 없는 경우 이 정보를 추가할 필요가 없습니다.

  2. 폐기가 주요 변경인 경우, 다음 텍스트를 추가하세요:

    이 변경은 주요 변경입니다.
    

    사용자들이 도움이 될 수 있는 다른 컨텍스트별 세부 정보를 추가할 수 있습니다.

  3. 콘텐츠 위와 아래에 다음 HTML 주석을 추가하세요. remove_date에는 제거될 릴리스 후 3개월 후의 날짜를 설정하세요.

    <!--- start_remove 다음 콘텐츠는 remove_date: 'YYYY-MM-DD'에 제거됩니다 -->
    
    ## 제목 (폐기됨)
    
    세부 정보:
    **계층:** 프리미엄, 얼티밋
    **제공:** GitLab.com, 셀프매니지드, GitLab 전용
    
    경고:
    이 기능은 GitLab 14.8 버전에서 [폐기](<link-to-issue>)되었으며
    15.4 버전에서 제거될 예정입니다. 대신 [기능 X](<link-to-docs>)를 사용하세요.
    
    <!--- end_remove -->
    
  4. 페이지 제목 뒤에 (폐기됨)이라는 단어를 추가하도록 왼쪽 내비게이션을 수정하는 머지 리퀘스트를 오픈하세요.

페이지 제거

기능이 제거된 릴리스 중에 내용을 제거로 표시하십시오. 제거 후 세 달 동안 제목과 제거 표시자를 유지합니다.

페이지를 제거하려면:

  1. 페이지 제목을 남겨 두세요. 기타 모든 콘텐츠, 히스토리 항목 및 WARNING: 단어를 포함하여 모든 콘텐츠를 제거합니다.
  2. 제목 다음에 (deprecated)(removed)로 변경하세요.
  3. YAML 메타데이터를 업데이트하세요:
    • remove_date에는 기능이 제거된 릴리스 후 3개월 후의 날짜를 설정하세요.
    • redirect_to에는 합리적인 파일 경로를 설정하세요. 명확한 페이지가 없는 경우 문서 홈페이지를 사용하세요.
    ---
    stage: Data Stores
    group: Global Search
    info: 이 페이지와 관련된 Stage/Group에 할당된 기술 작성자를 확인하려면 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에서 [deprecated](<link-to-issue>)되었으며, X.Y에서 [제거되었음](<link-to-issue>)을 사용하세요. 대신 [feature X](<link-to-docs>)를 사용하세요.
    
  4. 전역 내비게이션에서 페이지 항목을 제거하려면 gitlab-docsnavigation.yaml을 편집하세요.

이 콘텐츠는 기술 문서 팀의 정기 예약 작업의 일부로 문서에서 제거되었습니다.

주제 제거

주제를 제거하려면:

  1. 제목과 폐기 및 제거 정보를 남겨 두세요. 기타 모든 콘텐츠, 히스토리 항목 및 WARNING: 단어를 포함하여 모든 콘텐츠를 제거합니다.
  2. 제목 뒤에 (removed)를 추가하세요.
  3. 주제 위와 아래에 다음 HTML 주석을 추가하세요. remove_date에는 제거된 릴리스 이후 3개월 후의 날짜를 설정하세요.

    <!--- start_remove 다음 콘텐츠는 remove_date: 'YYYY-MM-DD'에 제거됩니다. -->
    
    ## 제목 (removed)
    
    DETAILS:
    **Tier:** Premium, Ultimate
    **Offering:** GitLab.com, Self-managed, GitLab Dedicated
    
    이 기능은 GitLab X.Y에서 [deprecated](<link-to-issue>)되었으며, X.Y에서 [제거되었음](<link-to-issue>)을 사용하세요. 대신 [feature X](<link-to-docs>)를 사용하세요.
    
    <!--- end_remove -->
    

이 콘텐츠는 기술 문서 팀의 정기 예약 작업의 일부로 문서에서 제거되었습니다.

제거된 버전

GitLab은 현재 주요 버전 및 이전 두 개의 주요 버전을 지원합니다. 예를 들어, 16.0이 현재 주요 버전이라면 GitLab 16.0, 15.0 및 14.0의 모든 주요 및 마이너 릴리스가 지원됩니다.

지원되는 버전 목록은 여기에서 확인하세요.

지원되지 않는 버전을 참조하는 히스토리 항목이나 인라인 텍스트가 나타나면 제거할 수 있습니다.

히스토리에서 기능 플래그 이벤트가 모두 지원되지 않는 버전에서 발생한 경우에만 기능 플래그 뒤의 기능에 대한 정보를 제거하세요. 플래그가 제거되지 않았다면, 독자는 이것이 도입된 시기를 알아야 합니다.

과거의 기능 정보는 릴리스 포스트에서 확인할 수 있습니다. 또는 해당 작업이 수행된 이슈 또는 머지 리퀘스트를 검색하여 확인할 수 있습니다.

미래 버전의 유망한 기능

미래 릴리스에서 기능을 제공할 수 있음을 약속하지 마십시오. 예를 들어, “이 기능의 지원이 계획되어 있습니다.”와 같은 구문을 피하십시오.

우리는 미래의 기능 작업을 보장할 수 없으며 이러한 약속은 법적 문제를 유발할 수 있습니다. 대신 이슈가 존재함을 말하세요. 예를 들어:

  • 개선사항 지원은 [이슈 <issue_number>](LINK-TO-ISSUE)에서 제안되었습니다.
  • 이 작업을 수행할 수 없지만 [이슈 12345](LINK-TO-ISSUE)에서 이 동작을 변경하도록 제안되었습니다.

우리는 기능을 제거할 계획이 있다고 할 수 있습니다.

미래 기능에 대한 법적 고지

아직 제공하지 않은 기능에 대해 반드시 작성해야 하는 경우, 해당하는 내용에서 다음과 같은 내용의 미래 지향적 진술에 대한 법적 고지를 넣으십시오.

고지:
이 페이지에는 미래 제품, 기능 및 기능에 관한 정보가 포함되어 있습니다.
제시된 정보는 정보 제공 목적으로만 사용되며, 구매 또는 계획 목적으로 이 정보를 신뢰하지 마십시오.
이 페이지에 언급된 모든 프로젝트와 마찬가지로, 언급된 사항은 변경되거나 지연될 수 있습니다.
모든 제품, 기능 또는 기능의 개발, 출시 및 타이밍은 GitLab Inc.의 재량에 따라 명시됩니다.

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

고지: 이 페이지에는 미래 제품, 기능 및 기능에 관한 정보가 포함되어 있습니다. 제시된 정보는 정보 제공 목적으로만 사용되며, 구매 또는 계획 목적으로 이 정보를 신뢰하지 마십시오. 이 페이지에 언급된 모든 프로젝트와 마찬가지로, 언급된 사항은 변경되거나 지연될 수 있습니다. 모든 제품, 기능 또는 기능의 개발, 출시 및 타이밍은 GitLab Inc.의 재량에 따라 명시됩니다.

페이지의 모든 콘텐츠를 사용할 수 없는 경우 페이지 상단에 미래 지향적 진술에 대한 법적 고지를 한 번 사용하십시오.

주제의 콘텐츠가 준비되지 않은 경우 해당 주제에 고지를 사용하십시오.