GitLabドキュメントに貢献すること

GitLabドキュメンテーションは、GitLabの設定、使い方、トラブルシューティングの方法に関する情報の真実の唯一の情報源(SSOT) 。誰でもGitLabドキュメントに貢献することができます。

イシューのない作業

ドキュメントの更新にイシューは必要ありません。

https://docs.gitlab.com で、どのページの下部でも、ページソースの表示またはWeb IDE での編集を選択し、マージリクエストを開始することができます。

代わりに

  • /doc ディレクトリ](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc) にあるページ[を選択し、そこから編集します。
  • Vale lintingツールをインストールして実行し、その結果生じたイシューを修正してみてください。

コードを開発している場合、ドキュメントを更新するワークフローは少し異なります。詳細はマージリクエストのワークフローをご覧ください。

利用可能なイシューの検索

未解決のイシューを探している場合は、新しいコントリビューターのために特別に作成されたドキュメンテーションのイシューのリストをレビューすることができます。

取り組みたいイシューが見つかったら、以下のリンクをクリックしてください：

  • そのイシューがすでに誰かに割り当てられている場合は、別のイシューを選んでください。

  • イシューが未割り当ての場合は、コメントを追加して、そのイシューに取り組むよう依頼してください。ハッカソンの場合は、@docs-hackathon を使用してください。それ以外の場合は、@gl-docsteam を使用してください。例えば

     @docs-hackathon I would like to work on this issue
  • 一度に3つ以上のイシューを依頼しないでください。

マージリクエストを開く

ドキュメントを更新する準備ができたら

  1. GitLabリポジトリにアクセスしてください。
  2. 右上のコーナーで、Fork を選択します。フォークすると、GitLab.com上にリポジトリのコピーが作成されます。
  3. フォークしたページで、\doc ディレクトリにあるドキュメントページを探します。
  4. Gitを知っているなら、変更を加えてマージリクエストを開いてください。そうでない場合は、以下の手順に従ってください：
    1. 右上の「編集」>「単一ファイルの編集」を選択します。
    2. 変更を加えます。
    3. 変更を提出する準備ができたら、コミットメッセージテキストボックスにコミットメッセージを入力してください。3-5単語で、大文字で始め、ピリオドで終わらせないでください。
    4. 変更をコミット を選択します。
    5. 左サイドバーで、コード > マージリクエストを選択します。
    6. 新しいマージリクエストを選択します。
    7. ソースブランチで、フォークとブランチを選択します。ブランチを作成していない場合は、masterを master選択します。masterターゲットブランチには master、masterGitLabリポジトリのブランチを master選択します。
    8. ブランチを比較するを選択し、続行します。新しいマージリクエストが開きます。
    9. ドキュメントテンプレートを選択します。説明には、変更点の簡単な概要と、関連するイシューがある場合はそちらへのリンクを記述します。
    10. マージリクエストを作成を選択します。

ヘルプを求める

以下の場合は、テクニカルライティングチームに助けを求めてください：

  • ドキュメンテーションの適切な場所の選択にお困りの場合。
  • ドキュメンテーションのアイデアやアウトラインについて相談したい
  • その他のヘルプを依頼したい

あなたを助けることができる誰かを特定するために：

  1. 該当するDevOpsステージグループのテクニカルライターを探してください。
  2. どちらか：
    • 緊急のヘルプが必要な場合は、イシューまたはマージリクエストでテクニカルライターを直接指定してください。
    • 緊急でないヘルプが必要な場合は、イシューまたはマージリクエストでテクニカルライターにpingを送信してください。

GitLab Slackワークスペースのメンバーであれば、#docs チャンネルでヘルプをリクエストできます。

ブランチの命名

メインの GitLab プロジェクトの CI/CD パイプラインは、ドキュメントの変更だけを含むマージリクエストに対して、より短時間で高速なパイプラインを実行するように設定されています。

Omnibus や Chart、Operator にドキュメンテーションのみの変更を投稿して、より短いパイプラインを実行させる場合は、ブランチに名前をつける際に以下のガイドラインに従う必要があります：

Branch name有効な例
で開始します。docs/ docs/update-api-issues
で開始します。docs- docs-update-api-issues
で終わる-docs 123-update-api-issues-docs