InfoGrab DocsInfoGrab Docs

문서 변경 사항 백포트

요약

백포트에는 두 가지 유형이 있습니다: 유지 관리 버전: 모든 maintainer는 변경 사항(일반적으로 버그 수정이지만 중요한 문서 변경 사항 포함)을 유지 관리 버전에 백포트할 수 있습니다. 유지 관리 버전보다 오래된 릴리스: 유지 관리 정책이 준수되도록 보장하기 위해, 이러한 릴리스로의 머지는 릴리스 매니저만 할 수 있습니다.

백포트에는 두 가지 유형이 있습니다:

  • 유지 관리 버전: 모든 maintainer는 변경 사항(일반적으로 버그 수정이지만 중요한 문서 변경 사항 포함)을 유지 관리 버전에 백포트할 수 있습니다. 유지 관리 버전은 현재 안정 릴리스와 그 이전 두 릴리스입니다. 개발 중인 마일스톤이 18.7이라면, 유지 관리되는 안정 브랜치는 18-6-stable-ee, 18-5-stable-ee, 18-4-stable-ee입니다.

  • 유지 관리 버전보다 오래된 릴리스: 유지 관리 정책이 준수되도록 보장하기 위해, 이러한 릴리스로의 머지는 릴리스 매니저만 할 수 있습니다.

유지 관리 버전으로 문서 변경 사항 백포트#

유지 관리 버전으로 문서 변경 사항을 백포트하려면:

  1. 먼저 변경 사항을 기본 브랜치에 머지합니다.
  2. 릴리스 문서를 따라 백포트 머지 리퀘스트를 생성합니다. 안정 브랜치에서 만든 브랜치에 머지된 커밋을 체리픽하여 두 브랜치에 같은 커밋이 존재하도록 합니다.
  3. 머지 리퀘스트의 대상을 안정 브랜치(예: 18-6-stable-ee)로 설정하고 안정 브랜치 템플릿을 사용합니다.
  4. 다른 테크니컬 라이터 또는 maintainer에게 머지 리퀘스트를 할당하여 리뷰와 머지를 요청합니다.
  5. docs 사이트에 변경 사항을 배포합니다.

릴리스 매니저를 참여시킬 필요가 없습니다.

이전 릴리스로 문서 변경 사항 백포트#

이전 안정 릴리스로 문서를 백포트하는 경우는 매우 드물어야 합니다. 문서를 백포트하는 합당한 이유로는 법적 문제, 긴급 보안 수정, 사용자의 업그레이드를 방해하거나 데이터 손실을 유발할 수 있는 콘텐츠 수정 등이 있습니다.

유지 관리 버전보다 오래된 릴리스로 문서 변경 사항을 백포트하려면:

이슈 생성#

사전 요구 사항:

@gitlab-org/tw-leadership could I get your approval for this documentation backport?

technical writing 리더십이 백포트를 승인한 후에는 변경 사항을 백포트하는 머지 리퀘스트를 생성할 수 있습니다.

변경 사항을 백포트하는 머지 리퀘스트 생성#

사전 요구 사항:

  • 백포트를 요청하는 사람이 이 단계를 수행합니다. 백포트가 필요한 프로젝트에서 최소 Developer 권한이 있어야 합니다.

변경 사항을 백포트하려면, 변경 사항이 적용되어야 하는 버전의 안정 브랜치에 변경 사항을 머지합니다.

  • 릴리스 docs 가이드라인을 따라 백포트를 포함한 머지 리퀘스트를 열고, 이전에 연 이슈를 언급하여 연결되도록 합니다.

  • 리뷰를 위해 머지 리퀘스트를 technical writer에게 할당합니다.

  • technical writer가 머지 리퀘스트를 승인한 후, 리뷰 및 머지를 위해 머지 리퀘스트를 릴리스 매니저에게 할당합니다.

    이슈를 릴리스 매니저에게 언급하고, 필요한 모든 맥락을 제공합니다.

변경 사항이 다음 위치에 나타나려면:

  • docs.gitlab.com의 경우, 릴리스 매니저가 머지 리퀘스트를 안정 브랜치에 머지하기만 하면 되며, technical writer가 백포트 변경 사항을 배포해야 합니다.

  • gitlab.com/help의 경우, 변경 사항이 GitLab 릴리스의 일부여야 합니다. 릴리스 매니저가 다음에 생성하는 릴리스에 변경 사항을 포함시킬 수 있습니다. 이 단계는 선택 사항입니다.

백포트 변경 사항 배포#

사전 요구 사항:

변경 사항이 적절한 안정 브랜치에 머지된 후에는 백포트된 변경 사항을 배포해야 합니다.

GitLab 17.9 이상에서 적용된 변경 사항 배포#

docs-gitlab-com에서 새 파이프라인을 실행합니다. 안정 버전과 일치하는 브랜치 이름(예: 17.9)을 선택합니다.

  • 해당 브랜치에 대한 병렬 배포가 실행되어 자동으로 배포됩니다.

  • 버전화된 문서를 포함하고 오프라인에서 사용할 수 있는 Docker 이미지가 생성됩니다.

GitLab 17.8 이하에서 적용된 변경 사항 배포#

gitlab-docs에서 새 파이프라인을 실행합니다. 안정 버전과 일치하는 브랜치 이름(예: 17.8 또는 16.0)을 선택합니다.

  • 버전화된 문서를 포함하고 오프라인에서 사용할 수 있는 Docker 이미지가 생성됩니다.

최근 세 개의 안정 브랜치 이외의 버전에 적용된 변경 사항 배포#

백포트 변경 사항이 최근 세 개의 안정 브랜치 이외의 버전에 적용된 경우 docs 아카이브 사이트를 업데이트합니다:

  • 이전 지침에 따라 Docker 이미지가 빌드되었는지 확인합니다.

  • gitlab-docs-archives 리포지터리에서 새 파이프라인을 실행합니다.

  • 파이프라인이 완료된 후 https://archives.docs.gitlab.com으로 이동하여 변경 사항이 올바른 버전에서 사용 가능한지 확인합니다.

이전 문서 버전 보기#

이전 버전의 문서는 docs.gitlab.com에서 확인할 수 있습니다. 이전 버전을 보려면 오른쪽 상단에서 드롭다운 목록의 버전 번호를 선택합니다.

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

  • 문서 아카이브를 확인합니다.

  • GitLab 리포지터리로 이동하여 버전별 브랜치를 선택합니다. 예를 들어, 19.2 브랜치에는 GitLab 19.2에 대한 문서가 있습니다.

문서 변경 사항 백포트

GitLab v19.6
원문 보기

요약

백포트에는 두 가지 유형이 있습니다: 유지 관리 버전: 모든 maintainer는 변경 사항(일반적으로 버그 수정이지만 중요한 문서 변경 사항 포함)을 유지 관리 버전에 백포트할 수 있습니다. 유지 관리 버전보다 오래된 릴리스: 유지 관리 정책이 준수되도록 보장하기 위해, 이러한 릴리스로의 머지는 릴리스 매니저만 할 수 있습니다.

백포트에는 두 가지 유형이 있습니다:

  • 유지 관리 버전: 모든 maintainer는 변경 사항(일반적으로 버그 수정이지만 중요한 문서 변경 사항 포함)을 유지 관리 버전에 백포트할 수 있습니다. 유지 관리 버전은 현재 안정 릴리스와 그 이전 두 릴리스입니다. 개발 중인 마일스톤이 18.7이라면, 유지 관리되는 안정 브랜치는 18-6-stable-ee, 18-5-stable-ee, 18-4-stable-ee입니다.

  • 유지 관리 버전보다 오래된 릴리스: 유지 관리 정책이 준수되도록 보장하기 위해, 이러한 릴리스로의 머지는 릴리스 매니저만 할 수 있습니다.

유지 관리 버전으로 문서 변경 사항 백포트#

유지 관리 버전으로 문서 변경 사항을 백포트하려면:

  1. 먼저 변경 사항을 기본 브랜치에 머지합니다.
  2. 릴리스 문서를 따라 백포트 머지 리퀘스트를 생성합니다. 안정 브랜치에서 만든 브랜치에 머지된 커밋을 체리픽하여 두 브랜치에 같은 커밋이 존재하도록 합니다.
  3. 머지 리퀘스트의 대상을 안정 브랜치(예: 18-6-stable-ee)로 설정하고 안정 브랜치 템플릿을 사용합니다.
  4. 다른 테크니컬 라이터 또는 maintainer에게 머지 리퀘스트를 할당하여 리뷰와 머지를 요청합니다.
  5. docs 사이트에 변경 사항을 배포합니다.

릴리스 매니저를 참여시킬 필요가 없습니다.

이전 릴리스로 문서 변경 사항 백포트#

이전 안정 릴리스로 문서를 백포트하는 경우는 매우 드물어야 합니다. 문서를 백포트하는 합당한 이유로는 법적 문제, 긴급 보안 수정, 사용자의 업그레이드를 방해하거나 데이터 손실을 유발할 수 있는 콘텐츠 수정 등이 있습니다.

유지 관리 버전보다 오래된 릴리스로 문서 변경 사항을 백포트하려면:

이슈 생성#

사전 요구 사항:

@gitlab-org/tw-leadership could I get your approval for this documentation backport?

technical writing 리더십이 백포트를 승인한 후에는 변경 사항을 백포트하는 머지 리퀘스트를 생성할 수 있습니다.

변경 사항을 백포트하는 머지 리퀘스트 생성#

사전 요구 사항:

  • 백포트를 요청하는 사람이 이 단계를 수행합니다. 백포트가 필요한 프로젝트에서 최소 Developer 권한이 있어야 합니다.

변경 사항을 백포트하려면, 변경 사항이 적용되어야 하는 버전의 안정 브랜치에 변경 사항을 머지합니다.

  • 릴리스 docs 가이드라인을 따라 백포트를 포함한 머지 리퀘스트를 열고, 이전에 연 이슈를 언급하여 연결되도록 합니다.

  • 리뷰를 위해 머지 리퀘스트를 technical writer에게 할당합니다.

  • technical writer가 머지 리퀘스트를 승인한 후, 리뷰 및 머지를 위해 머지 리퀘스트를 릴리스 매니저에게 할당합니다.

    이슈를 릴리스 매니저에게 언급하고, 필요한 모든 맥락을 제공합니다.

변경 사항이 다음 위치에 나타나려면:

  • docs.gitlab.com의 경우, 릴리스 매니저가 머지 리퀘스트를 안정 브랜치에 머지하기만 하면 되며, technical writer가 백포트 변경 사항을 배포해야 합니다.

  • gitlab.com/help의 경우, 변경 사항이 GitLab 릴리스의 일부여야 합니다. 릴리스 매니저가 다음에 생성하는 릴리스에 변경 사항을 포함시킬 수 있습니다. 이 단계는 선택 사항입니다.

백포트 변경 사항 배포#

사전 요구 사항:

변경 사항이 적절한 안정 브랜치에 머지된 후에는 백포트된 변경 사항을 배포해야 합니다.

GitLab 17.9 이상에서 적용된 변경 사항 배포#

docs-gitlab-com에서 새 파이프라인을 실행합니다. 안정 버전과 일치하는 브랜치 이름(예: 17.9)을 선택합니다.

  • 해당 브랜치에 대한 병렬 배포가 실행되어 자동으로 배포됩니다.

  • 버전화된 문서를 포함하고 오프라인에서 사용할 수 있는 Docker 이미지가 생성됩니다.

GitLab 17.8 이하에서 적용된 변경 사항 배포#

gitlab-docs에서 새 파이프라인을 실행합니다. 안정 버전과 일치하는 브랜치 이름(예: 17.8 또는 16.0)을 선택합니다.

  • 버전화된 문서를 포함하고 오프라인에서 사용할 수 있는 Docker 이미지가 생성됩니다.

최근 세 개의 안정 브랜치 이외의 버전에 적용된 변경 사항 배포#

백포트 변경 사항이 최근 세 개의 안정 브랜치 이외의 버전에 적용된 경우 docs 아카이브 사이트를 업데이트합니다:

  • 이전 지침에 따라 Docker 이미지가 빌드되었는지 확인합니다.

  • gitlab-docs-archives 리포지터리에서 새 파이프라인을 실행합니다.

  • 파이프라인이 완료된 후 https://archives.docs.gitlab.com으로 이동하여 변경 사항이 올바른 버전에서 사용 가능한지 확인합니다.

이전 문서 버전 보기#

이전 버전의 문서는 docs.gitlab.com에서 확인할 수 있습니다. 이전 버전을 보려면 오른쪽 상단에서 드롭다운 목록의 버전 번호를 선택합니다.

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

  • 문서 아카이브를 확인합니다.

  • GitLab 리포지터리로 이동하여 버전별 브랜치를 선택합니다. 예를 들어, 19.2 브랜치에는 GitLab 19.2에 대한 문서가 있습니다.