記事のタイトルの変更
場合によっては、ヘルプ記事のタイトルを変更する必要があります。 記事のタイトルを変更するときは、いくつかの考慮事項に留意する必要があります。
ファイル名の変更に関する背景
記事のタイトルは、いくつかの理由で、その記事を含む Markdown ファイルの名前に直接対応しています。
- SEO URL で記事の内容に関連する実際の単語を使うと、検索エンジンでのその記事の重み付けがいっそう大きくなります。 詳しくは、Google の検索エンジン最適化スターター ガイドで "URL の構造の改善" に関する説明をご覧ください。
タイトル変更時に更新を検討する必要がある場所
記事のタイトルを新しくするときは、複数の場所の更新が必要になる場合があります。
フロント マターとメタデータ セクション
各記事の先頭には、YAML 構文を使って書式設定されたメタデータ セクションまたはフロント マターがあります。 このメタデータ セクションによって記事のタイトルが生成され、そこにはリダイレクトや、場合によっては再利用可能なイントロ テキストにリンクする短い説明の conref などの、他の重要なデータが含まれています。
---
title: Your article name
intro:
redirect_from:
- /articles/older-outdated-article-name/
---
フロント マターの更新のチェックリスト
- 文章の先頭の 1 字だけに大文字を使ってタイトルを更新します
- リダイレクトを更新します。 記事のタイトルを変更したら、ほぼすべての場合、記事の古い URL を参照するリダイレクトを追加し、古い記事のフロント マターにリダイレクトを保持する必要があります。
ファイル名
ターミナルで git mv コマンドを使って、ファイルの名前を変更できます。
$ git mv old-article-name.md new-article-name.md
親インデックス ファイル
TOC を生成する親 index.md ファイルで、そのファイルへのリンクを必ず更新します。
他の記事内のインライン リンク
ドキュメントでは記事の間がリンクされています。 ファイル名とタイトルの "両方" を検索して、更新するリンクを見つけることをお勧めします。
GitHub
間のリンク
製品で古いタイトルへのリンクを検索します。 古いリンクが見つかった場合は、関連するチームまたはエンジニアに連絡して、リンクが変更されたことを伝え、それを更新するよう依頼します。 連絡する相手がわからない場合は、GitHub Docs チームのメンバーに問い合わせてください。 礼儀として、更新されたリンクを含む pull request を作成し、更新された記事タイトルが出荷された後でそれをマージするよう、関連するチームに依頼することもできます。