Skip to content

文書化ガイドライン#

独自警告

この記事はこちらの日本語訳であり、日本語訳のガイドラインではありません

ワークフロー#

Autowareのドキュメントへの貢献は歓迎されており、貢献ガイドラインに記載されている事項と同じ原則に従う必要があります。小規模で限定的な変更は、このリポジトリをフォークしてプルリクエストを送信することで行うことができますが、より大きな変更についてはまずGitHubディスカッションを介してコミュニティおよびAutowareメンテナと話し合う必要があります。

小さな変更の例は以下のとおりです:

  • スペルや文法の間違いを修正する
  • 壊れたリンクを修正する
  • トラブルシューティングガイドなど、明確に定義された既存のページに追加を行う。

より大きな変更の例としては、以下のようなものがあります:

  • チュートリアルなど、大量の詳細情報を含む新しいページを追加する
  • 既存のドキュメント構造の再編成

スタイルガイド#

可能な限りGoogle開発者ドキュメントのスタイルガイドを参照する必要があります。そのガイドのハイライトページを読むことをお勧めしますが、そうでない場合は以下の重要な点に注意してください。

ヒント#

変更をプレビューする方法#

ドキュメントWebサイトで変更をプレビューするには2つの方法があります。

1. GitHub Actionsワークフローの使用#

以下の手順に従ってください。

  1. リポジトリへのプルリクエストを作成します。
  2. サイドバーからdeploy-docsラベルを追加します(下の図を参照)。
  3. 数分待つと、github-actionsボットがプルリクエストのプレビューのURLを通知します。

deploy-docs-label

2. ローカル環境でMkDocsサーバーを実行する#

PRを作成する代わりに、mkdocsコマンドを使用して、ローカルコンピュータ上に AutowareのドキュメントWebサイトを構築できます。 Ubuntu OS を使用していると仮定して、次のコマンドを実行して必要なライブラリをインストールします。

python3 -m pip install -U $(curl -fsSL https://raw.githubusercontent.com/autowarefoundation/autoware-github-actions/main/deploy-docs/mkdocs-requirements.txt)

次にドキュメントディレクトリでmkdocs serveを実行します。

cd /PATH/TO/YOUR-autoware-documentation
mkdocs serve

MkDocsサーバーが起動します。http://127.0.0.1:8000/にアクセスして、Webサイトのプレビューを表示します。