マニュアルの編集(英語の原文の編集)
ローカルのテキストファイルを編集することによってマニュアルを編集できます。ファイルはリポジトリ内のファイルと同期しています。編集されたファイルをリポジトリに送る(コミットする)ことによってマニュアルの文章が変えられます。
このマニュアルは reStructuredText (RST) マークアアップ言語で書かれており、テキストエディタで編集することが出来ます。このマニュアルのソースファイルをRSTからHTMLのページに変換(ビルド)することで、ローカルでプレビューすることが出来ます。
アップデート
まず、ローカルのファイルが最新版(オンラインリポジトリと同じ)にアップデートされているかを確認してください:
make update
書く
アップデートが終わったら manual
フォルダー内の .rst
ファイルを好きなテキストエディタで編集できます。
Be sure to check the Writing Style Guide for conventions and Markup Style Guide to learn how to write in the reStructuredText markup language.
頑張ってください!
大きな編集
If you are going to add or overhaul a section, be sure to check carefully that it does not already exist. In some places, the docs are so disorganized that sections may be duplicated or in a strange location. In the case that you find a duplicate or out of place section, create an issue explaining the issue, and optionally include a revision (actual changes).
単純でなく確実に明瞭だと言えない編集 (たとえばフォルダの移動など) を行う前には、コミュニティが持つマニュアルへのビジョンに沿うものであるかを、マニュアルの管理者に相談する必要があります。それがあなたの時間と善意を最も活かす方法です。そうでない場合、何らかの理由で競合が発生してあなたの編集が却下されたり、レビューに時間がかかる可能性があります。例えば、あなたが変更したいセクションを既に別の人が作業していたり、セクション自体が削除される予定であったり、Blender への計画的な変更による更新があるかもしれません。
コミュニケーション を取ることによって生産的環境を保ちましょう。話し合って努力の無駄を防ぎましょう。それがBlender マニュアルを良くします。
助け・答えが必要な場合
書きたい機能の仕様に疑問がある場合は、その分野の Blender 開発の責任者に問い合わせるか、非公式の Blender Chat 内の、ユーザーサポートチャンネル #docs
または #blender-coders
で質問してください。
Blender itself has a system of module owners with developer and artist members who are responsible for the design and maintenance of the assigned Blender areas. See the module owners page for more information.
Preview(プレビュー)
To view your changes, build the manual as instructed.
Keep in mind that you can also build only the chapter you just edited to view it quickly.
Open the generated .html
files inside the build/html
folder using your web browser,
or refresh the page if you have it open already.
アップロード(コミット)
変更に満足したら、それをアップロードして、オンラインマニュアルに反映されるようにします。最初は、誰かがレビューしてフィードバックを返せるように、パッチを提出します。その後、変更を直接コミットできるようになります。この過程の詳細は、次のセクションで紹介します。