Docs/#1 english document (#20)

closes: #1 * docs: add mkdocs i18n * docs: page in i18n lukasgeiter/mkdocs-awesome-pages-plugin#58 * docs: add files * docs: introduction * docs: introduction preparation * docs: introduction * docs: update * docs: update scenario format * docs: update scenario format * docs: result format * docs: result format * chore: git mv * docs: add use_case english * docs: update localization * docs: update localization * docs: update obstacle_segmentation * docs: update obstacle_segmentation * docs: update perception * docs: update perception.en.md * docs: update performance_diag * docs: update performance_diag.en.md * chore: update index.en.md * fix: pre-commit * Apply suggestions from code review markdown style: "code", "emphasis" correct grammar errors Co-authored-by: Michał Kiełczykowski <[email protected]> * Apply suggestions from code review Co-authored-by: Michał Kiełczykowski <[email protected]> * docs: fix typo * docs: update i18n information * Update docs/result_format/index.en.md jsonl fomat Co-authored-by: Michał Kiełczykowski <[email protected]> * docs: update why JSONL format * Update docs/scenario_format/index.en.md scenario description Co-authored-by: Michał Kiełczykowski <[email protected]> * docs: update description of vehicle_id * chore: move sample folder * docs: update converge evaluation start condition * docs: update perception onnx conversion * docs: delete scenario time unit * Update docs/use_case/localization.en.md localization input bag topic list Co-authored-by: Michał Kiełczykowski <[email protected]> * Update docs/use_case/perception.en.md Co-authored-by: Michał Kiełczykowski <[email protected]> * Update docs/use_case/perception.en.md Co-authored-by: Michał Kiełczykowski <[email protected]> * docs: update perception launch sensing module * docs: add hyperlink * Update docs/use_case/performance_diag.en.md Co-authored-by: Michał Kiełczykowski <[email protected]> * docs: setting file creation * docs: obstacle segmentation point cloud error hz * docs: Example usage flow * fix: lint, format * fix: spell check * docs: mkdocs setting * docs: quick start * fix: markdown lint * chore: git mv * docs: update overview * docs: update run.md * chore: git mv * chore: git mv * docs: update setup * fix: yaml lint * fix: sample directory path * docs: update * docs: add make map directory * docs: make dataset directory * Update docs/quick_start/setup.en.md Co-authored-by: Michał Kiełczykowski <[email protected]> * Update docs/quick_start/installation.en.md Co-authored-by: Michał Kiełczykowski <[email protected]> * docs: delete unnecessary sentence Co-authored-by: Michał Kiełczykowski <[email protected]>
tier4 · Nov 4, 2022 · fc10331 · fc10331
1 parent e073bd9
commit fc10331
Show file tree

Hide file tree

Showing 50 changed files with 1,915 additions and 483 deletions.
diff --git a/.github/workflows/deploy-document.yaml b/.github/workflows/deploy-document.yaml
@@ -20,6 +20,5 @@ jobs:
         with:
           python-version: 3.x
 
-      - run: pip install mkdocs-material
-      - run: pip install mkdocs-awesome-pages-plugin
+      - run: pip install -r requirements.txt
       - run: mkdocs gh-deploy --force
diff --git a/docs/.pages b/docs/.pages
@@ -1,6 +1,8 @@
 nav:
-  - index.md
-  - introduction
+  - index.en.md
+  - index.ja.md
+  - quick_start
+  - overview
   - scenario_format
   - result_format
   - use_case
diff --git a/docs/index.en.md b/docs/index.en.md
@@ -0,0 +1,7 @@
+# Driving Log Replayer Documentation
+
+Language selection is available by pressing the "文 A" icon at the top of the page.
+
+## About Driving Log Replayer
+
+Driving Log Replayer is a ROS2 package that evaluates the performance of Autoware.Universe based on previously recorded input data. It allows for defining and checking whether the assumptions of the system operation have been met.
diff --git a/docs/index.ja.md b/docs/index.ja.md
@@ -0,0 +1,7 @@
+# Driving Log Replayer ドキュメント
+
+ページトップの "文 A" アイコンから言語の切り替えが可能です。
+
+## Driving Log Replayer について
+
+Driving Log Replayer は Autoware.Universe の機能を評価する ROS2 のパッケージです。
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/introduction/.pages b/docs/introduction/.pages
diff --git a/docs/introduction/index.md b/docs/introduction/index.md
diff --git a/docs/introduction/preparation.md b/docs/introduction/preparation.md
diff --git a/docs/overview/.pages b/docs/overview/.pages
@@ -0,0 +1,7 @@
+nav:
+  - index.en.md
+  - index.ja.md
+  - setup.en.md
+  - setup.ja.md
+  - command.en.md
+  - command.ja.md
diff --git a/docs/overview/command.en.md b/docs/overview/command.en.md
@@ -0,0 +1,64 @@
+# Command
+
+After installing `driving_log_replayer_cli`, the `driving_log_replayer` command can be executed in the terminal.
+The `driving_log_replayer` command has subcommands.
+The arguments required for each command can be displayed by specifying the `--help` option.
+
+```shell
+# driving_log_replayer top level help
+driving_log_replayer --help
+
+# show version
+driving_log_replayer --version
+
+# show subcommand help
+driving_log_replayer subcommand --help
+
+# show subsubcommand help
+driving_log_replayer subcommand subsubcommand --help
+```
+
+## CLI subcommands
+
+The list of supported subcommands can be found below:
+
+- configure
+- simulation
+
+### driving_log_replayer configure
+
+Command to manipulate the configuration file `.driving_log_replayer.config.toml`.
+
+```shell
+# Set data_directory, output_directory, and autoware_path to the profile name specified by -p.
+# If -p is omitted, default is specified for the profile name.
+driving_log_replayer configure register -d ${data_directory} -o ${output_directory} -a ${autoware_path} [-p ${profile}]
+```
+
+### driving_log_replayer simulation
+
+Available commands to run the Autoware evaluation:
+
+```shell
+# simulation run, both jsonl and json result files are output
+driving_log_replayer simulation run -p ${profile}
+
+# simulation run, do not convert jsonl to json
+driving_log_replayer simulation run -p ${profile} --no-json
+
+# Check results and display summary of result files under output_directory
+driving_log_replayer simulation show-result ${output_directory}
+
+# Convert result files to json
+driving_log_replayer simulation convert-result ${output_directory}
+```
+
+## Run driving_log_replayer with wasim
+
+If you have access rights to [Autoware Evaluator](https://docs.web.auto/user-manuals/evaluator/introduction) provided by TIER IV,
+you can also use [wasim](https://docs.web.auto/developers-guides/wasim/introduction).
+
+Please see the [wasim documentation site](https://docs.web.auto/developers-guides/wasim/use-cases/run-simulations-locally/) for an example of tool usage.
+
+Since wasim downloads and executes scenarios from Autoware Evaluator, it can only execute scenarios that are already registered in the cloud environment.
+For scenarios not registered in the cloud, use `driving_log_replayer_cli`.
diff --git a/docs/introduction/run.md → docs/overview/command.ja.md b/docs/introduction/run.md → docs/overview/command.ja.md
@@ -1,8 +1,4 @@
-# 起動方法
-
-driving_log_replayer を起動するには、autoware のワークスペースのビルド、cli のインストール、及び、評価するデータの準備を事前に済ませている必要がある。
-
-## コマンド
+# コマンド
 
 driving_log_replayer_cli のコマンドについて解説する。
 
@@ -36,13 +32,13 @@ driving_log_replayer subcommand subsubcommand --help
 設定ファイル.driving_log_replayer.config.toml を操作するコマンド。
 
 ```shell
-# -pで指定したprofile名デフォルト値defaultにdata_directory、output_directory、autoware_pathを設定する
+# -pで指定したprofile名にdata_directory、output_directory、autoware_pathを設定する。-pを省略した場合はdefaultが指定される
 driving_log_replayer configure register -d ${data_directory} -o ${output_directory} -a ${autoware_path} [-p ${profile}]
 ```
 
 ### driving_log_replayer simulation
 
-simulation 実行に利用する。
+simulation を実行するコマンド
 
 ```shell
 # simulation 実行、jsonlとjsonの両方の結果ファイルが出力される
@@ -54,16 +50,16 @@ driving_log_replayer simulation run -p ${profile} --no-json
 # 結果の確認、output_directory以下の結果ファイルのサマリーを表示する
 driving_log_replayer simulation show-result ${output_directory}
 
-# 結果ファイルをjson変換、クラウドで実行したjsonlやno-jsonで実行した結果ファイルを変換する
+# 結果ファイルをjsonに変換する
 driving_log_replayer simulation convert-result ${output_directory}
 ```
 
 ## wasim による driving_log_replayer 実行
 
-TIER IV が提供している[Autoware Evaluator](https://docs.web.auto/user-manuals/evaluator/introduction "Autoware Evaluator")へ
-アクセス権がある場合は[wasim](https://docs.web.auto/developers-guides/wasim/introduction "wasim")を利用することもできる。
+TIER IV が提供している[Autoware Evaluator](https://docs.web.auto/user-manuals/evaluator/introduction)へ
+アクセス権がある場合は[wasim](https://docs.web.auto/developers-guides/wasim/introduction)を利用することもできる。
 
-使い方は[ドキュメントサイト](https://docs.web.auto/developers-guides/wasim/use-cases/run-simulations-locally/ "ドキュメントサイト")を参照。
+使い方は[ドキュメントサイト](https://docs.web.auto/developers-guides/wasim/use-cases/run-simulations-locally/)を参照。
 
-wasim は Autoware Evaluator に登録済みのシナリオをダウンロードして実行するので、クラウド環境に登録済みのシナリオしか実行出来ない。
+wasim は Autoware Evaluator からシナリオをダウンロードして実行するので、クラウド環境に登録済みのシナリオしか実行出来ない。
 クラウドに登録してないシナリオは driving_log_replayer_cli を使用する。
diff --git a/docs/introduction/images/architecture.png → docs/overview/images/architecture.png b/docs/introduction/images/architecture.png → docs/overview/images/architecture.png
diff --git a/docs/introduction/images/overview.drawio.svg → docs/overview/images/overview.drawio.svg b/docs/introduction/images/overview.drawio.svg → docs/overview/images/overview.drawio.svg