ドキュメント

この入門ガイドは、ドキュメントに貢献するために必要なツールと知識を習得するのに役立ちます。

慣れていない場合は、 :ref:`reStructuredText言語 <contributing/documentation/rst-intro>をお読みください。 次に、ドキュメントへの貢献を開始するための2つの方法があります。

  • **小規模な変更**には、段落の追加やタイプミスの修正など、**GitHubインターフェイス**を使用することをお勧めします。 これは、変更を提出するための最も簡単で最速の方法であり、非技術的な人に適しています。 :ref:の「コントリビューション/ドキュメンテーション/first-contribution」セクションに直接ジャンプして開始します。

  • 新しいページを追加するなど、より複雑な変更を行うには、**Gitを使用 し、ドキュメントのローカルコピーから作業する必要があります。 :ref:の「貢献/ドキュメント/セットアップ」セクションの指示に従って環境を準備してください。

関連項目

Odooに貢献する方法をほかにも見つけましょう

reStructuredText (RST)

このドキュメントは reStructuredText （RST） で記述されています。 RST は、通常のテキストにマークアップを加えることで、見出し・画像・注釈などを含められる`軽量マークアップ言語 <https://en.wikipedia.org/wiki/Lightweight_markup_language>`_ です。 RST は、たとえ初めてでも簡単に使うことができます。

重要

ドキュメントを書く際には、 :doc:`content <documentation/content_guidelines>`と :doc:`RST <documentation/rst_guidelines>`ガイドラインに注意してください。 これにより、ドキュメントが一貫性を保ち、Odoo チームによる変更の承認を容易にします。

環境のセットアップ

以下の手順は、ドキュメントにローカルで変更を加えるための環境を準備し、GitHub にプッシュするのに役立ちます。 このセクションをスキップして、すでにこのステップを完了している場合やGitHubインターフェースから変更を加えたい場合は、 ドキュメントへの貢献 にアクセスしてください。

  1. まず、 GitHub アカウント を作成します。 Odoo は GitHub を使用して製品のソースコードを管理します。ここで変更を送信します。

  2. 新しい SSH キーを生成し、GitHub アカウント に登録します。

  3. github. を開きます。 om/odoo/documentation そして右上隅にある Fork ボタンをクリックして、あなたのアカウントにリポジトリのフォーク(your own copy ) を作成します。 これにより、メインのコードベースに影響を与えずに変更できるコードベースのコピーが作成されます。 Odoo で作業している場合は、この手順をスキップします。

  4. Git をインストール します。Git はコマンドライン（テキストベースのインターフェイス ）ツールであり、ファイルに加えられた変更履歴を記録するだけでなく、同じファイルの異なるバージョンを同時に作業できる点が大きな特長です。 つまり、他の人が保留中の作業をしていても、それを上書きする心配をせずに自分の変更作業を進めることができます。

    Git のインストールディレクトリがシステムの PATH 変数に含まれていることを確認します。

    Linux および macOS で PATH 変数を更新するためのガイド に従って、Git のインストールパス（デフォルトでは /usr/bin/git ）を追加します。

  5. あなた自身を将来の貢献者として識別するためにGitを設定します。GitHubに登録したのと同じメールアドレスを入力してください。

    $ git config --global user.name "Your Name"
$ git config --global user.email "youremail@example.com"

  6. Gitでソースをクローンし、ローカルリポジトリに移動します。

    $ git clone git@github.com:odoo/documentation.git
$ cd documentation

  7. メインのコードベースではなく、フォークに変更をプッシュするように Git を設定します。 以下のコマンドでは、フォークを作成したGitHubアカウントの名前に`<your_github_account>`を置き換えます。 Odoo で作業している場合は、この手順をスキップします。

    $ git remote add dev git@github.com:<your_github_account>/documentation.git

  8. 異なるシステムから来るライター間のコラボレーションを容易にするためにGitを設定します。

    $ git config --global core.autocrlf input
$ git config commit.template `pwd`/commit_template.txt

  9. Python と pip の最新リリースをインストールします。

  10. ドキュメントの Python 依存関係を pip でインストールします。

    $ pip install -r requirements.txt

    Python の依存関係のインストールディレクトリがシステムの PATH 変数に含まれていることを確認します。

    guide に従って、Linux と macOS の PATH 変数を、Python 依存関係のインストールパスで (デフォルトでは ~/ に更新します。 ocal/bin).

  11. Makeをインストールします。

    $ sudo apt install make -y

  12. Install pngquant.

  13. これで、Gitで :ref:`最初のコントリビューション <contributing/documentation/first-contribution>`を作成する準備ができました。

ドキュメントへの貢献

  1. まず、 GitHub アカウント を作成します。 Odoo は GitHub を使用して製品のソースコードを管理します。ここで変更を送信します。

  2. 変更しようとしているバージョンのドキュメントを参照していることを確認します。 バージョンは、トップメニューのドロップダウンから選択できます。

  3. 変更したいページに進み、ページの右上隅にある Edit on GitHub ボタンをクリックしてください。

  4. Fork this repository ボタンをクリックして、あなたのアカウントにリポジトリのフォーク(your own copy ) を作成します。 これにより、メインのコードベースに影響を与えずに変更できるコードベースのコピーが作成されます。 Odoo で作業している場合は、この手順をスキップします。

    ../_images/fork-repository.png

  5. content と RST ガイドラインに従って、必要な変更を行います。

    ちなみに

    プレビュー変更 ボタンをクリックして、より人に読みやすい形式であなたの貢献を確認してください。 プレビューがすべてのマークアップを正しく処理できないことに注意してください。たとえば、メモとヒントはプレーンテキストとして表示されます。

  6. ページの下部までスクロールし、小さなフォームに記入して変更を提案します。 最初のテキストボックスに、変更の概要を簡単に記述します。 例えば、"タイプミスの修正"または"販売注文の請求書作成のドキュメントを追加します。 2番目のテキストボックスで、変更を提案している*なぜ*を説明します。それから、 :guilabel:`変更を提案する`ボタンをクリックします。

    ../_images/propose-changes.png

  7. 変更内容を確認し、 Create pull request ボタンをクリックしてください。

  8. Allow edits from maintainer チェックボックスをオンにします。Odoo で作業する場合はこの手順をスキップします。

  9. 変更について書いた要約を確認し、 Create pull request ボタンをもう一度クリックしてください。

  10. ページの下部にある統合状況を確認し、問題を解決します。

  11. PR がマージする準備ができ次第、Odooチームのメンバーが自動的にレビューに割り当てられます。 査読者に質問や発言がある場合は、それらをコメントとして投稿し、あなたには電子メールで通知されます。 これらのコメントは、貢献が進むために解決されなければなりません。

  12. 変更が承認されると、審査員はそれらを統合し、翌日オンラインで表示されます。