リダイレクトを構成する

リダイレクトについて

ユーザーの検索機能に影響する記事に変更が加えられた場合、古いバージョンから現在のコンテンツへのリダイレクトが作成されます。記事のタイトルが変更された場合、新しいバージョンが追加された場合、またはファイルの場所が変更された場合に、これを行う必要があります。

リダイレクトは、ローカルまたは外部で構成できます。

ローカルリダイレクトの構成

GitHub Docs 内では、あるファイルから別のファイルに、またはあるバージョンから別のバージョンにリダイレクトできます。

ファイル間でのリダイレクト

記事の名前を変更し、そのすべてのバージョンの古い URL を新しい URL にリダイレクトする場合は、記事の古い名前へのパスを含む redirect_from frontmatter を使用します。記事の名前を変更し、さまざまなバージョンで別の URL へのリダイレクトを行う場合は、「バージョン間でのリダイレクト」セクションの手順に従います。

次の例では、「All about commits」という記事の名前が「Creating your first commit」に変更されました。 redirect_from frontmatter は、古い記事の URL にアクセスするすべてのユーザーを新しい記事の URL にリダイレクトします。

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

詳細については、GitHub Docs README ファイル内の redirect_from を参照してください。

バージョンが含まれていない URL の自動リダイレクト

ページの URL がバージョンなしで入力された場合 (https://docs.github.com/VERSION/ARTICLE ではなく https://docs.github.com/ARTICLE)、サイトはページの最初の使用可能なバージョンに自動的にリダイレクトします。

優先順位は lib/all-versions.js で指定します。現在の優先順位は次のとおりです。

GitHub Free、GitHub Pro、または GitHub Team (fpt)
GitHub Enterprise Cloud (ghec)
GitHub Enterprise Server (ghes)

ARTICLE というタイトルのページが GitHub Enterprise Cloud と GitHub Enterprise Server でのみ使用可能な場合、GitHub Enterprise Cloud は GitHub Enterprise Server よりも優先されるため、リンク https://docs.github.com/ARTICLE は自動的に https://docs.github.com/enterprise-cloud@latest/ARTICLE にリダイレクトします。

Free、Pro、Team のいずれかで ARTICLE が使用可能な場合、fpt ページにバージョンセグメントがないため、リダイレクトは発生しません。https://docs.github.com/ARTICLE の fpt コンテンツがレンダリングされます。

バージョン間でのリダイレクト

あるバージョンの記事の URL を別のバージョンの URL にリダイレクトするか、完全に別の URL にリダイレクトする場合は、src/redirects ディレクトリ内の redirect-exceptions.txt ファイルを更新する必要があります。

たとえば、記事の Free、Pro、または Team (fpt) バージョンを削除すると、URL は次に使用可能なバージョンのページに自動的にリダイレクトされます。優先順位の低いバージョンにリダイレクトする場合、または別のページに完全にリダイレクトする場合は、例外を指定する必要があります。

redirect-exceptions ファイル内の各エントリは、バージョンを含むリダイレクト_先_のパスで始まり、その次にリダイレクト_元_パスの順序なしリストが続いたものでなければなりません。次の例では、順序なしリスト内のパスは、GitHub Enterprise Cloud バージョンの「Organizationのメンバー情報のエクスポート」にリダイレクトされます。

/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",

この記事の内容