리디렉션 구성

리디렉션 정보

사용자가 찾을 수 있는 기능에 영향을 주는 문서가 변경되면 오래된 버전에서 현재 내용 보기로 리디렉션을 만듭니다. 문서의 제목이 변경되거나, 새 버전이 추가되거나, 파일 위치가 변경된 경우 이 작업을 수행해야 할 수 있습니다.

리디렉션은 로컬 또는 외부에서 구성할 수 있습니다.

로컬 리디렉션 구성

GitHub Docs에서 한 파일에서 다른 파일로 또는 한 버전에서 다른 버전으로 리디렉션할 수 있습니다.

파일 간 리디렉션

문서의 이름을 변경하고 이전 URL이 모든 버전에서 새 URL로 리디렉션되도록 하려면 문서의 이전 이름 경로와 함께 redirect_from 프론트매터를 사용합니다. 문서의 이름을 변경하고 버전마다 다른 URL로 리디렉션되도록 하려면 버전 간 리디렉션 섹션의 단계를 따릅니다.

다음 예제에서는 "커밋에 대한 모든 것" 문서의 이름이 "첫 번째 커밋 만들기"로 바뀌었습니다 redirect_from 프론트매터는 이전 문서 URL로 이동하는 모든 사용자를 새 문서 URL로 리디렉션합니다.

title: Creating your first commit
redirect_from:
  - /content/get-started/all-about-commits

자세한 내용은 redirect_from GitHub Docs 추가 정보 파일을 참조하세요.

버전을 포함하지 않는 URL에 대한 자동 리디렉션

페이지 URL이 버전 없이 입력되면(https://docs.github.com/ARTICLE 대신https://docs.github.com/VERSION/ARTICLE) 사이트에서 페이지의 사용 가능한 첫 번째 버전으로 자동으로 리디렉션됩니다.

우선 순위는 lib/all-versions.ts에 지정됩니다. 현재 우선 순위는 다음과 같습니다.

1. GitHub Free, GitHub Pro, GitHub Team (fpt)
2. GitHub Enterprise Cloud (ghec)
3. GitHub Enterprise Server (ghes)

GitHub Enterprise Cloud 및 GitHub Enterprise Server에서만 ARTICLE 제목의 페이지를 사용할 수 있는 경우 GitHub Enterprise Cloud이(가) GitHub Enterprise Server보다 우선하므로 링크 https://docs.github.com/ARTICLE가 https://docs.github.com/enterprise-cloud@latest/ARTICLE으로 자동 리디렉션됩니다.

무료, Pro 또는 Team에서 ARTICLE(을)를 사용할 수 있는 경우 fpt 페이지에 버전 세그먼트가 없으므로 리디렉션이 작동되지 않으므로 https://docs.github.com/ARTICLE의 fpt 콘텐츠가 렌더링됩니다.

버전 간 리디렉션

문서의 한 버전에 대한 URL을 다른 버전의 URL로 리디렉션하거나 완전히 다른 URL로 리디렉션하려면 src/redirects 디렉터리에서 redirect-exceptions.txt 파일을 업데이트해야 합니다.

예를 들어 무료, Pro 또는 Team(fpt) 버전의 문서를 제거하면, URL이 사용 가능한 다음 버전의 페이지로 자동으로 리디렉션됩니다. 우선 순위가 낮은 버전으로 리디렉션하거나 완전히 다른 페이지로 리디렉션하려면 예외를 지정해야 합니다.

redirect-exceptions 파일의 각 항목은 버전을 포함하여 리디렉션 목표 경로로 시작해야 하며, 리디렉션 출발 경로의 순서가 지정되지 않은 목록이 다음으로 와야 합니다. 다음 예제에서는 순서가 지정되지 않은 목록의 경로가 조직의 구성원 정보 내보내기의 GitHub Enterprise Cloud 버전으로 리디렉션됩니다.

/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
  - /enterprise-server@3.3/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
  - /enterprise-server@3.4/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization
  - /enterprise-server@3.5/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization

외부 리디렉션 구성

콘텐츠가 GitHub Docs 사이트 외부로 이동하는 경우는 거의 없습니다. 이러한 유형의 리디렉션은 src/redirects 디렉터리의 external-sites.json 파일을 업데이트 합니다.

external-sites.json 파일의 각 항목은 키 값 쌍입니다. 여기서 키는 콘텐츠가 있던 위치의 경로이고 값은 리디렉션해야 하는 경로입니다.

  "/github-status": "https://www.githubstatus.com/",
  "/articles/github-security": "https://github.com/security",