• ソースファイル
• 公開
• 古いバージョンのアップデート
• 他のリポジトリにあるドキュメント
• 毎月のリリースプロセス（バージョン）
• 危険ボット

ドキュメントサイトアーキテクチャ

gitlab-docs プロジェクトは GitLab ドキュメントウェブサイトを生成するために使用されるリポジトリをホストし、https://docs.gitlab.comにデプロイされます。これはNanoc静的サイトジェネレータを使用しています。

詳しくはgitlab-docs アーキテクチャページ をご覧ください。

ソースファイル

ドキュメントのソースファイルは、製品コードと同じリポジトリにあります。

ドキュメントのイシューとマージリクエストはそれぞれのリポジトリの一部であり、すべてDocumentation というラベルがついています。

公開

GitLab、GitLab Runner、GitLab Operator、Omnibus GitLab、Chartsのドキュメントはhttps://docs.gitlab.comに公開されています。

アプリケーションにも同じドキュメントが含まれています。製品内のヘルプを表示するには、URLにアクセスし、最後に/help を追加してください。現在のエディションとバージョンのヘルプのみが含まれます。

他のバージョンのヘルプはhttps://docs.gitlab.com/archives/でご覧いただけます。

古いバージョンのアップデート

すでにリリースされているGitLabバージョンのドキュメントを追加したり編集したりする必要がある場合は、パッチリリースのランブックに従ってください。

他のリポジトリにあるドキュメント

プライマリ・リポジトリ以外のリポジトリにコードとドキュメントがある場合は、そのリポジトリにコードと一緒にドキュメントを保管してください。

そうすれば、以下のいずれかの方法を使うことができます：

• 推奨https://docs.gitlab.com で公開されている製品リストにリポジトリを追加します。ドキュメントページのソースは内部リポジトリに残りますが、作成されたページはhttps://docs.gitlab.comでインデックス化され、検索可能になります。
• 推奨https://docs.gitlab.com のグローバルナビゲーションに、その外部リポジトリのドキュメントに直接リンクするエントリを追加します。https://docs.gitlab.comでは、ドキュメント・ページはインデックス化されず、検索もできません。例を参照してください。
• gitlab リポジトリに製品のランディングページを作成し、グローバルナビゲーションにランディングページを追加します。ランディングページはhttps://docs.gitlab.comにインデックスされ検索可能になりますが、ドキュメントの残りの部分はインデックスされません。例えば、GitLab Workflow extension for VS Codeのようなものです。私たちは、リンクのリストを含むページの使用を推奨していません。したがって、推奨されるオプションが実行不可能な場合にのみ、このオプションを使用してください。

毎月のリリースプロセス（バージョン）

docsウェブサイトはバージョンをサポートしており、毎月最新のものをリストに追加しています。詳しくは毎月のリリースプロセスをご覧ください。

危険ボット

GitLabはコードレビューのいくつかの要素にDangerを使っています。マージリクエストのdocsの変更に対して、/doc のファイルが変更されるたびに、Danger Botはドキュメンテーションプロセスに関するさらなる指示をコメントに残します。この設定はGitLabリポジトリの/danger/documentation/のDangerfile 。