Deprecated
GitLab이 기능을 폐기하거나 삭제할 때는 문서를 업데이트하기 위해 다음 프로세스를 사용합니다. 그러기 위해서는 해당 내용을 삭제되었음을 나타내는 “deprecated” 또는 “removed”로 일시적으로 변경해야 합니다.
:::Warning 만약 기능이 일반적으로 사용 가능하지 않다면, 이 지침을 따를 필요없이 해당 내용을 즉시 삭제할 수 있습니다. :::
참고: GraphQL 문서 및 REST API 문서에 대한 별도의 프로세스가 있습니다.
페이지 또는 주제를 폐기합니다
페이지 또는 주제를 폐기하려면 다음을 수행하세요:
-
제목 뒤에
(deprecated)
을 추가합니다. 제거된 날짜 및 대체 기능을 설명하는 경고를 사용합니다.```markdown ## 제목 (deprecated)
Tier: 프리미엄, 얼티메이트 Offering: GitLab.com, Self-Managed, GitLab Dedicated:::Warning 이 기능은 GitLab 14.8에서 폐기되었으며 15.4에서 삭제될 예정입니다. 기능 X를 대신 사용하십시오. :::
이 기능을 제거할 날짜를 확신할 수 없거나 대체 기능이 없는 경우에는 이 정보를 추가할 필요가 없습니다.
-
폐기가
breaking change
인 경우, 다음 텍스트를 추가합니다:이 변경 사항은 `breaking change`입니다.
사용자들이 도움이 될 수 있는 해당 작업과 관련된 추가적인 구체적인 세부 정보를 추가할 수 있습니다.
-
내용 위와 아래에 다음 HTML 주석을 추가합니다.
remove_date
에는 삭제될 릴리즈 날짜로부터 3개월 후의 날짜를 설정합니다.<!--- start_remove 다음 콘텐츠는 remove_date: 'YYYY-MM-DD'에 삭제됩니다 --> ## 제목 (deprecated) DETAILS: **Tier:** 프리미엄, 얼티메이트 **Offering:** GitLab.com, Self-Managed, GitLab Dedicated :::Warning 이 기능은 GitLab 14.8에서 [폐기되었으며](https://issue-link) 15.4에서 삭제될 예정입니다. [기능 X](link-to-docs.md)를 대신 사용하십시오. ::: <!--- end_remove -->
-
페이지 제목 뒤에 병합 요청을 열어서
(deprecated)
단어를 왼쪽 내비게이션에 추가합니다.
페이지 제거
기능이 제거된 리릴리즈에서 콘텐츠를 삭제할 때 표시합니다. 제목 및 삭제된 표식은 제거된 후 3개월까지 유지됩니다.
페이지를 제거하려면:
- 페이지 제목을 남겨두고 히스토리 항목 및
WARNING:
단어를 포함한 다른 모든 콘텐츠를 제거합니다. - 제목 뒤에
(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:** 프리미엄, 얼티메이트 **Offering:** GitLab.com, Self-Managed, GitLab Dedicated 이 기능은 GitLab X.Y에서 [폐기되었으며](https://issue-link) [제거되었습니다](https://issue-link) X.Y에서. [기능 X](link-to-docs.md)를 대신 사용하십시오.
-
-
gitlab-docs
의navigation.yaml
를 편집하여 전역 내비게이션에서 페이지 항목을 제거합니다.
이 콘텐츠는 기술 작성팀의 정기적인 예정된 작업의 일부로 문서에서 제거됩니다.
주제 제거
주제를 제거하려면:
- 제목과 폐기 및 삭제 세부 정보를 남겨두고 히스토리 항목 및
WARNING:
단어를 포함한 다른 모든 콘텐츠를 제거합니다. - 제목 뒤에
(removed)
를 추가합니다. -
다음 HTML 주석을 주제 위와 아래에 추가합니다.
remove_date
에는 해당 주제가 제거된 릴리즈 날짜로부터 3개월 후의 날짜를 설정합니다.<!--- start_remove 다음 콘텐츠는 remove_date: 'YYYY-MM-DD'에 삭제됩니다 --> ## 제목 (removed) DETAILS: **Tier:** 프리미엄, 얼티메이트 **Offering:** GitLab.com, Self-Managed, GitLab Dedicated 이 기능은 GitLab X.Y에서 [폐기되었으며](https://issue-link) [제거되었습니다](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에서 제거됩니다.
지원되지 않는 페이지를 제거하는 대신:
- 날짜를 추가하여 미래 3개월 내로 페이지가 월간 유지 보수 작업에서 제거되도록 합니다.
- 제목에
Removed
를 추가하지 마십시오.
만약 X_changes.md
페이지에 지원되지 않는 버전의 다른 섹션으로의 상대적인 링크가 포함되어 있다면, docs-lint links
작업이 실패할 수 있습니다. 이 상대적인 링크는 archived version으로 대체할 수 있습니다. 지원되지 않는 버전에서 제거될 최신 부 버전을 선택하십시오.