사용 중단 및 제거

GitLab에서 기능을 사용 중단하거나 제거할 때, 문서를 업데이트하기 위해 다음 프로세스를 사용하세요.
이 프로세스는 콘텐츠를 삭제하기 전에 “사용 중단(deprecated)” 또는 “제거(removed)”로 일시적으로 변경해야 합니다.

기능이 일반적으로 사용할 수 없는 경우, 이러한 지침을 따르지 않고 콘텐츠를 즉시 삭제할 수 있습니다.

주의:
GraphQL 문서REST API 문서에 대한 별도의 프로세스가 존재합니다.

페이지 또는 주제 사용 중단

페이지 또는 주제를 사용 중단하려면:

  1. 제목 뒤에 (deprecated)를 추가하세요. 사용 중단된 시점, 제거될 시점 및 대체 기능에 대해 설명하는 경고를 사용하세요.

    ## 제목 (deprecated)
    
    DETAILS:
    **Tier:** Premium, Ultimate
    **Offering:** GitLab.com, Self-managed, GitLab Dedicated  
    
    WARNING:
    이 기능은 GitLab 14.8에서 [사용 중단(deprecated)](https://issue-link)되었으며  
    15.4에서 제거될 예정입니다. 대신 [기능 X](link-to-docs.md)를 사용하세요.  
    

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

  2. 사용 중단이 파괴적인 변경 사항인 경우, 다음 텍스트를 추가하세요:

    이 변경 사항은 파괴적인 변경 사항입니다.  
    

    사용자에게 도움이 될 수 있는 추가적인 맥락 관련 세부정보를 추가할 수 있습니다.

  3. 다음 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에서 [사용 중단(deprecated)](https://issue-link)되었으며  
    15.4에서 제거될 예정입니다. 대신 [기능 X](link-to-docs.md)를 사용하세요.  
    
    <!--- end_remove -->
    
  4. 페이지 제목 뒤에 왼쪽 탐색에서 (deprecated)라는 단어를 추가하는 머지 요청을 여세요.

페이지 제거

기능이 제거된 릴리즈 동안 콘텐츠를 제거로 표시하세요.
제목과 제거 표시가 제거된 후 3개월 동안 유지됩니다.

페이지를 제거하려면:

  1. 페이지 제목을 남깁니다. WARNING:라는 단어를 포함한 모든 다른 콘텐츠를 제거하세요.
  2. 제목 뒤에서 (deprecated)(removed)로 변경하세요.
  3. 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에서 [사용 중단(deprecated)](https://issue-link)되었고  
    X.Y에서 [제거(removed)](https://issue-link)되었습니다.  
    대신 [기능 X](link-to-docs.md)를 사용하세요.  
    
  4. navigation.yaml에서 페이지의 항목을 제거하여 전역 탐색에서 삭제하세요.

이 콘텐츠는 기술 작문 팀의 정기적으로 예정된 작업 일환으로 문서에서 제거됩니다.

주제를 제거합니다

주제를 제거하려면:

  1. 폐기 및 제거에 대한 제목과 세부정보를 남깁니다. 모든 다른 콘텐츠는 제거합니다, 이력 항목 및 WARNING: 단어를 포함합니다.

  2. 제목 뒤에 (removed)를 추가합니다.

  3. 주제 위와 아래에 다음 HTML 주석을 추가합니다. remove_date에 제거된 릴리스 후 3개월이 되는 날짜를 설정합니다.

    <!--- start_remove 다음 내용은 remove_date: 'YYYY-MM-DD'에 제거됩니다. -->
    
    ## 제목 (removed)
    
    세부정보:
    **Tier:** Premium, Ultimate
    **Offering:** GitLab.com, Self-managed, GitLab Dedicated
    
    이 기능은 [사용 중단되었습니다](https://issue-link) GitLab X.Y에서
    그리고 [제거되었습니다](https://issue-link) X.Y에서.
    대신 [기능 X](link-to-docs.md)를 사용하세요.
    
    <!--- end_remove -->
    

이 콘텐츠는 기술 문서 작성 팀의 정기적으로 예약된 작업의 일환으로 문서에서 제거됩니다.

버전별 업그레이드 페이지 제거

버전별 업그레이드 페이지는 doc/update/versions/ 디렉토리에 있습니다.

주요 이정표에 대해 버전별 업그레이드 페이지를 즉시 제거하지 않습니다. 이는 사용자가 이전 버전에서 업그레이드할 시간을 허용합니다.

예를 들어, doc/update/versions/14_changes.md.3 이정표 동안 제거해야 합니다. 따라서 14_changes.md는 GitLab 17.3에서 제거됩니다.

지지하지 않는 페이지를 제거하는 대신:

X_changes.md 페이지에 제거된 다른 섹션에 대한 상대 링크가 포함되어 있으면 버전 정리의 일환으로 docs-lint links 작업이 실패할 수 있습니다. 그 상대 링크를 보관된 버전으로 대체할 수 있습니다. 제거될 지원되지 않는 버전의 최신 소수 버전을 선택하세요.