Weblateドキュメントへの貢献

ドキュメント ページを選んで改善してください。ページの右上隅にある GitHub で編集 ボタンをクリックすると簡単に編集できます。

Documentation guidelines

書き込みに際して従うべきガイドライン:

  1. 妥当な翻訳のドキュメントの部分は削除しないでください。

  2. 明確でわかりやすい語彙を使用してください。技術文書を記述しているのであって、詩を書いているのではありません。ドキュメントを読む人がすべてネイティブスピーカーなわけではないことに注意してください。

  3. 確信が持てない場合は、遠慮なく質問してください。編集中に、特定の機能について質問をする必要がある場合は、回答を得られる前にそのドキュメントを変更しないでください。つまり、変更するか質問するか、どちらかにしてください。両方を同時に実行しないでください。

  4. ドキュメントに従って説明どおりの操作を行い、変更を確認してください。

  5. 査読とマージを簡単かつ迅速に行えるように、変更を小さな単位で書き込んで公開ください。

  6. 大きな文章の構成を書き換えて変更する場合の手順:

    1. 書き換え

    2. 書き換えが査読され、洗練され、マージされたら、他の公開する段落構成を変更します。

Building the documentation locally

Documentation can be also edited and built locally, the Python requirements are in the docs dependency group in pyproject.toml. The build can be performed using ci/run-docs.

ヒント

You will also need graphviz installed to build the documentation.

Translating the documentation

ドキュメントの翻訳 ができます。

Documenting permissions, checks, add-ons and automatic suggestions

Several documentation sections use templates generated from the code. The following management commands are available:

All these commands output reStructuredText which is used as a template for the documentation. The easiest way to apply changes to the documentation is using visual diff in your editor.