사용 중단 및 제거
GitLab v19.1Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
GitLab에서 기능을 사용 중단(deprecate)하거나 제거(remove)할 때는 다음 프로세스에 따라 문서를 업데이트합니다. 기능이 일반적으로 사용 가능한 상태가 아닌 경우, 이 지침을 따르지 않고 콘텐츠를 즉시 삭제할 수 있습니다.
GitLab에서 기능을 사용 중단(deprecate)하거나 제거(remove)할 때는 다음 프로세스에 따라 문서를 업데이트합니다. 이 프로세스에서는 콘텐츠를 삭제하기 전에 일시적으로 "deprecated" 또는 "removed" 상태로 변경해야 합니다.
기능이 일반적으로 사용 가능한 상태가 아닌 경우, 이 지침을 따르지 않고 콘텐츠를 즉시 삭제할 수 있습니다.
다음과 같은 경우에는 별도의 프로세스가 적용됩니다:
-
기능 사용 중단과 관련 없는 페이지 이동, 이름 변경, 삭제를 위한 문서 리디렉션.
활발히 개발되지 않는 기능#
기능이 더 이상 활발히 개발되지 않지만 사용 중단 상태는 아닌 경우, 주제 제목과 버전 히스토리 아래에 다음 메모를 추가합니다:
<div class="admonition note"><div class="admonition-title">Note</div>
This feature is not under active development, but
[community contributions](https://about.gitlab.com/community/contribute/) are welcome.
</div>```
## 페이지 또는 주제 사용 중단
페이지 또는 주제를 사용 중단하려면:
- 제목 뒤에 `(deprecated)`를 추가합니다. 경고 `alert`를 사용하여 언제 사용 중단되었는지, 언제 제거될 예정인지, 그리고 대체 기능이 무엇인지 설명합니다.
title: Title (deprecated)#
[!warning] This feature was deprecated in GitLab 14.8 and is planned for removal in 15.4. Use feature X instead.
기능이 언제 제거될지 확실하지 않거나 대체 기능이 없는 경우, 해당 정보를 추가하지 않아도 됩니다.
- 사용 중단이 [브레이킹 체인지(breaking change)](/19.1/update/terminology/#breaking-change)인 경우, 다음 텍스트를 추가합니다:
This change is a breaking change.
사용자에게 도움이 될 수 있는 추가적인 문맥 세부 정보를 포함할 수 있습니다.
- 콘텐츠 위아래에 다음 HTML 주석을 추가합니다. `remove_date`는 [해당 기능이 제거되는 릴리즈](https://about.gitlab.com/releases/) 이후 3개월이 되는 날짜로 설정합니다.
title: Title (deprecated)#
[!warning] This feature was deprecated in GitLab 14.8 and is planned for removal in 15.4. Use feature X instead.
- 머지 리퀘스트를 열어 왼쪽 내비게이션의 페이지 제목 뒤에 `(deprecated)` 단어를 추가합니다.
## 페이지 제거
기능이 제거된 릴리즈 시점에 콘텐츠를 제거됨으로 표시합니다.
제목과 제거 표시는 제거 후 3개월이 될 때까지 유지됩니다.
페이지를 제거하려면:
- 페이지 제목은 그대로 둡니다. 히스토리 항목과 `details` 및 `alert` 단축코드(shortcode)를 포함한 다른 모든 콘텐츠를 제거합니다.
- `title` 뒤에서 `(deprecated)`를 `(removed)`로 변경합니다.
- YAML 메타데이터를 업데이트합니다:
`remove_date`의 값은 기능이 제거된 릴리즈 이후 3개월이 되는 날짜로 설정합니다.
- `redirect_to`에는 사용자와 AI 크롤러에게 관련 문맥을 제공하는 파일 경로를 설정합니다.
홈 페이지나 일반적인 랜딩 페이지로 리디렉션하는 것을 피합니다. 기능에 적합한 대체 페이지가 없는 경우, 제거를 설명하는 [사용 중단 공지](/19.1/update/deprecations/)로 리디렉션합니다.
```yaml
---
stage: AI-powered
group: Global Search
info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments>
remove_date: '2022-08-02'
redirect_to: '../newpath/to/file/_index.md'
title: Title (removed)
---
This feature was [deprecated](https://issue-link) in GitLab X.Y
and [removed](https://issue-link) in X.Y.
Use [feature X](link-to-docs.md) instead.
-
docs-gitlab-com에 있는navigation.yaml을 편집하여 글로벌 내비게이션에서 해당 페이지의 항목을 제거합니다. -
제거된 페이지에 대한 링크를 사용 중단 및 제거 페이지에서 검색합니다. 링크는
https://docs.gitlab.com/user/deprecated_page/와 같은 전체 URL 형식을 사용합니다. 링크를 발견하면 관련 YAML 파일을 업데이트합니다:body:섹션에서 제거된 페이지로의 링크를 삭제합니다. -
documentation_url:섹션에서 해당 항목이 페이지로 연결되는 경우 링크를 삭제합니다. -
Rake 태스크를 실행하여 문서를 업데이트합니다:
bin/rake gitlab:docs:compile_deprecations -
다른 리포지터리의 링크를 검색하고 업데이트합니다.
이 콘텐츠는 기술 문서 작성 팀의 정기적으로 예약된 태스크의 일환으로 문서에서 제거됩니다.
주제 제거#
주제를 제거하려면:
-
제목과 사용 중단 및 제거에 대한 세부 정보는 그대로 둡니다. 히스토리 항목과
details및alert단축코드를 포함한 다른 모든 콘텐츠를 제거합니다. -
제목 뒤에
(removed)를 추가합니다. -
주제 위아래에 다음 HTML 주석을 추가합니다.
remove_date는 해당 기능이 제거된 릴리즈 이후 3개월이 되는 날짜로 설정합니다.title: Title (removed) ---- <!--- start_remove The following content will be removed on remove_date: 'YYYY-MM-DD' --> This feature was [deprecated](https://issue-link) in GitLab X.Y and [removed](https://issue-link) in X.Y. Use [feature X](link-to-docs.md) instead. <!--- end_remove --> -
제거된 페이지에 대한 링크를 사용 중단 및 제거 페이지에서 검색합니다. 링크는
https://docs.gitlab.com/user/deprecated_page/와 같은 전체 URL 형식을 사용합니다. 링크를 발견하면 관련 YAML 파일을 업데이트합니다:body:섹션에서 제거된 페이지로의 링크를 삭제합니다. -
documentation_url:섹션에서 해당 항목이 페이지로 연결되는 경우 링크를 삭제합니다. -
Rake 태스크를 실행하여 문서를 업데이트합니다:
bin/rake gitlab:docs:compile_deprecations -
다른 리포지터리의 링크를 검색하고 업데이트합니다.
이 콘텐츠는 기술 문서 작성 팀의 정기적으로 예약된 태스크의 일환으로 문서에서 제거됩니다.
버전별 업그레이드 페이지 제거#
버전별 업그레이드 페이지는 doc/update/versions/ 디렉터리에 있습니다.
주요 마일스톤에 대한 버전별 업그레이드 페이지를 즉시 제거하지 않습니다. 이는 사용자가 이전 버전에서 업그레이드할 시간을 확보하기 위해서입니다.
예를 들어, doc/update/versions/14_changes.md는 .3 마일스톤 중에 제거되어야 합니다. 따라서 14_changes.md는 GitLab 17.3에서 제거됩니다.
지원되지 않는 페이지를 즉시 제거하는 대신:
-
향후 3개월 후의 날짜로 메모를 추가하여 월별 유지 관리 태스크 중에 페이지가 제거되도록 합니다.
-
제목에
Removed를 추가하지 않습니다.
X_changes.md 페이지에 버전 정리 과정에서 제거되는 다른 섹션에 대한 상대 링크가 포함된 경우, docs-lint links job이 실패할 수 있습니다. 해당 상대 링크를 아카이브 버전으로 대체할 수 있습니다.
제거될 지원되지 않는 버전의 최신 마이너 버전을 선택합니다.