製品バージョンの文書化
GitLab製品のドキュメントには、いつ機能が導入され、いつ更新または削除されたかを含むバージョン固有の情報が含まれています。
古いバージョンのドキュメントを見る
ドキュメントの旧バージョンはdocs.gitlab.com でご覧いただけます。以前のバージョンを表示するには、右上の「バージョン」を選択します。
docs.gitlab.com に掲載されていないバージョンを表示するには：
- ドキュメントアーカイブをご覧ください。
- GitLabリポジトリに移動し、バージョン固有のブランチを選択します。例えば、13.2ブランチにはGitLab 13.2のドキュメントがあります。
バージョン固有の機能のドキュメント
機能が追加または更新された場合、そのバージョン情報をバージョン履歴リスト項目として、またはインラインテキスト参照として含めることができます。
/development ディレクトリの Pages にバージョン情報を追加する必要はありません。
バージョン履歴項目の追加
トピック内のすべてのコンテンツが関連している場合は、トピックタイトルの後にバージョン履歴項目を追加します。たとえば
## Feature name
> [Introduced](<link-to-issue>) in GitLab 11.3.
This feature does something.
項目テキストには、これらの単語を順番に含める必要があります。大文字小文字は関係ありません。
-
introducedenabled,deprecated,changed,moved,recommended,removed, またはrenamed -
inまたはto -
GitLab(外部プロジェクトの場合はプロジェクト名)
可能であれば、関連するイシュー、マージリクエスト、エピックへのリンクを含めてください。料金ページへのリンクはしないでください。サブスクリプションの階層を含めないでください。
新機能の紹介
introduced を使う場合は、文頭に機能名か属詞をつけます：
> - Notifications for expiring tokens [introduced](<link-to-issue>) in GitLab 11.3.
> - Creating an issue from an issue board [introduced](<link-to-issue>) in GitLab 13.1.
サブスクリプション層の移動
機能を別のサブスクリプション層に移動する場合は、moved を使用してください：
> - [Moved](<link-to-issue>) from GitLab Ultimate to GitLab Premium in 11.8.
> - [Moved](<link-to-issue>) from GitLab Premium to GitLab Free in 12.0.
機能フラグの背後に導入された機能
機能フラグの後ろに機能が導入された場合、機能フラグの詳細をドキュメントに追加する必要があります。詳しくは、機能フラグの後ろにデプロイされた機能を文書化するを参照してください。
インラインバージョンテキスト
既存のトピックにコンテンツを追加する場合、既存のテキストにインラインでバージョン情報を追加できます。可能であれば、関連するイシュー、マージリクエスト、またはエピックへのリンクを含めてください。たとえば
The voting strategy [in GitLab 13.4 and later](<link-to-issue>) requires the primary and secondary
voters to agree.
非推奨と削除
機能が非推奨となり削除された場合は、関連ドキュメントを更新してください。
ページまたはトピックの非推奨化
ページやトピックを非推奨にするには：
-
タイトルの後に
(deprecated)を追加してください。いつ非推奨になったのか、いつ削除されるのか、代替機能を説明する警告を使用してください。## Title (deprecated) **(ULTIMATE SELF)** WARNING: This feature was [deprecated](<link-to-issue>) in GitLab 14.8 and is planned for removal in 15.4. Use [feature X](<link-to-issue>) instead.その機能がいつ削除されるかわからない場合や、代替機能が存在しない場合は、この情報を追加する必要はありません。
-
非推奨となる機能が破壊的な変更である場合は、このテキストを追加してください：
This change is a breaking change.ユーザーの助けになるような、状況特有の詳細を追加することができます。
-
コンテンツの上下に以下のHTMLコメントを追加してください。
remove_dateについては、リリースから3ヶ月後に削除される日付を設定してください。<!--- start_remove The following content will be removed on remove_date: 'YYYY-MM-DD' --> ## Title (deprecated) **(ULTIMATE SELF)** WARNING: This feature was [deprecated](<link-to-issue>) in GitLab 14.8 and is planned for removal in 15.4. Use [feature X](<link-to-issue>) instead. <!--- end_remove --> -
ページタイトルの後の左ナビに
(deprecated)という単語を追加するマージリクエストを開いてください。
ページの削除
機能が削除されたリリース中に、コンテンツを削除済みとしてマークします。タイトルと削除されたインジケータは、削除から3ヶ月後まで残ります。
ページを削除するには
- ページのタイトルは残してください。バージョン履歴の項目と
WARNING:という単語を含む、他のすべてのコンテンツを削除します。 - タイトルの後、
(deprecated)を(removed)に変更します。 - YAMLメタデータを更新します：
-
remove_dateの場合、その機能が削除されたリリースの3ヶ月後の日付を設定します。 -
redirect_toについては、意味のあるファイルへのパスを設定してください。明らかなページが存在しない場合は、docs ホームページを使用してください。
--- stage: Data Stores group: Global Search info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments remove_date: '2022-08-02' redirect_to: '../newpath/to/file/index.md' --- # Title (removed) **(ULTIMATE SELF)** This feature was [deprecated](<link-to-issue>) in GitLab X.Y and [removed](<link-to-issue>) in X.Y. Use [feature X](<link-to-issue>) instead. -
-
gitlab-docsのnavigation.yamlを編集して、グローバルナビゲーションからページのエントリを削除してください。
このコンテンツは、テクニカルライティングチームの定期的な作業の一環として、ドキュメントから削除されます。
トピックの削除
トピックを削除するには
- タイトルと非推奨および削除の詳細を残してください。バージョン履歴の項目や
WARNING:という単語を含む、その他の内容をすべて削除します。 - タイトルの後に
(removed)を追加します。 -
トピックの上下に以下のHTMLコメントを追加してください。
remove_dateについては、削除されたリリースから3ヶ月後の日付を設定してください。<!--- start_remove The following content will be removed on remove_date: 'YYYY-MM-DD' --> ## Title (removed) **(ULTIMATE SELF)** This feature was [deprecated](<link-to-issue>) in GitLab X.Y and [removed](<link-to-issue>) in X.Y. Use [feature X](<link-to-issue>) instead. <!--- end_remove -->
このコンテンツは、テクニカルライティングチームの定期的な作業の一環として、ドキュメントから削除されます。
削除されるバージョン
GitLabは現在のメジャーバージョンと2つ前のメジャーバージョンをサポートしています。例えば、16.0が現在のメジャーバージョンであれば、GitLab 16.0、15.0、14.0の全てのメジャーリリースとマイナーリリースがサポートされます。
サポートされるバージョンのリストを見る.
サポートされていないバージョンを参照するバージョン履歴項目やインラインテキストが表示された場合は、それを削除することができます。
過去の機能情報はリリースの投稿や、その作業が行われたイシューやマージリクエストを検索することで入手できます。
将来のバージョンで期待される機能
将来のリリースで機能を提供すると約束してはいけません。例えば、”この機能のサポートを予定しています。”といった表現は避けましょう。
このような約束は法的なイシューを引き起こす可能性があります。代わりに、イシューが存在することを述べてください。例えば
-
[issue <issue_number>](LINK-TO-ISSUE)で改良のサポートが提案されています。 - このようなことはできませんが、
[issue 12345](LINK-TO-ISSUE)、この動作を変更することを提案しています。
ある機能を削除する予定だと言うことができます。
今後の機能に関する免責事項
私たちがまだ提供していない機能について書かなければならない場合は、将来の見通しに関する記述について、この正確な免責事項を該当するコンテンツの近くに記載してください。
DISCLAIMER:
This page contains information related to upcoming products, features, and functionality.
It is important to note that the information presented is for informational purposes only.
Please do not rely on this information for purchasing or planning purposes.
As with all projects, the items mentioned on this page are subject to change or delay.
The development, release, and timing of any products, features, or functionality remain at the
sole discretion of GitLab Inc.
GitLab ドキュメントサイトでは、このように表示されます：
免責事項：このページには、今後の製品、機能、特徴に関する情報が含まれています。掲載されている情報は、情報提供のみを目的としていることにご注意ください。購入や計画の目的でこの情報を鵜呑みにしないでください。すべてのプロジェクトと同様に、このページに記載されている項目は変更または遅れる可能性があります。製品、特徴、または機能の開発者、リリース者、およびリリース時期は、GitLab Inc.の独自の裁量に委ねられます。
ページ上のすべての内容が利用できない場合は、ページ上部に一度、将来の見通しに関する記述についての免責事項を使用してください。
トピック内のコンテンツが準備できていない場合は、トピック内の免責事項を使用してください。