feat: modify page structure (#31)

* feat: move pages Signed-off-by: Takagi, Isamu <[email protected]> * feat: keep old url Signed-off-by: Takagi, Isamu <[email protected]> * fix: image url Signed-off-by: Takagi, Isamu <[email protected]> --------- Signed-off-by: Takagi, Isamu <[email protected]>
AutomotiveAIChallenge · Jun 18, 2024 · 31dbf1c · 31dbf1c
1 parent d4e9c91
commit 31dbf1c
Show file tree

Hide file tree

Showing 42 changed files with 160 additions and 151 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -26,8 +26,8 @@ repos:
     hooks:
       - id: yamllint
 
-  # - repo: https://github.com/tcort/markdown-link-check
-  #   rev: v3.12.2
-  #   hooks:
-  #     - id: markdown-link-check
-  #       args: [--quiet, --config=.markdown-link-check.json]
+  - repo: https://github.com/tcort/markdown-link-check
+    rev: v3.12.2
+    hooks:
+      - id: markdown-link-check
+        args: [--quiet, --config=.markdown-link-check.json]
diff --git a/docs/competition/finals.en.md b/docs/competition/finals.en.md
diff --git a/docs/competition/finals.ja.md b/docs/competition/finals.ja.md
diff --git a/docs/competition/preliminaries.en.md b/docs/competition/preliminaries.en.md
diff --git a/docs/competition/preliminaries.ja.md b/docs/competition/preliminaries.ja.md
diff --git a/docs/competition/rules/index.md b/docs/competition/rules/index.md
@@ -0,0 +1,3 @@
+# 移動しました
+
+このページの内容は[こちら](../../information/rules.ja.md)に移動しました。
diff --git a/docs/course/velocity_planning.md b/docs/course/velocity_planning.md
@@ -13,7 +13,7 @@
 本来Autowareでは以下のノードダイアグラムのように、GNSS、Lidar、IMUなどの情報をもとにekf_localizerが`/localization/kinematic_state`を計算します。
 
 <div align="center">
-  <img src="../images/localization_node.png" alt="Alt Text">
+  <img src="./images/localization_node.png" alt="Alt Text">
   <br>
   <em>Autowareのlocalizer周りの<a href="https://app.diagrams.net/?lightbox=1#Uhttps%3A%2F%2Fautowarefoundation.github.io%2Fautoware-documentation%2Fmain%2Fdesign%2Fautoware-architecture%2Fnode-diagram%2Foverall-node-diagram-autoware-universe.drawio.svg#%7B%22pageId%22%3A%22T6t2FfeAp1iw48vGkmOz%22%7D">ノードダイアグラム</a></em>
 </div>
@@ -25,7 +25,7 @@
 <br>
 
 <div align="center">
-  <img src="../images/practice_localization_node.png" alt="Alt Text">
+  <img src="./images/practice_localization_node.png" alt="Alt Text">
   <br>
   <em>autoware-practiceのdummy_localizer周りのノードダイアグラム</em>
 </div>
@@ -233,7 +233,7 @@ ros2 run autoware_practice_course p_controller --ros-args -p kp:=5.0 -p target_v
 <br>
 
 <div align="center">
-  <img src="../images/2-3/node_diagram.png" alt="Alt Text">
+  <img src="./images/2-3/node_diagram.png" alt="Alt Text">
   <br>
   <em>autoware-practiceのtrajectory_loader周りのノードダイアグラム</em>
 </div>
@@ -311,7 +311,7 @@ ros2 run autoware_practice_course longitudinal_controller --ros-args -p kp:=5.0
 図のような、直進・90度旋回・直進・90度旋回・直進となるような経路に追従することを考えます。
 
 <div align="center">
-  <img src="../images/2-4/trajectory_zigzag.png" alt="Alt Text">
+  <img src="./images/2-4/trajectory_zigzag.png" alt="Alt Text">
   <br>
   <em>今回の目標経路</em>
 </div>
@@ -325,7 +325,7 @@ ros2 run autoware_practice_course longitudinal_controller --ros-args -p kp:=5.0
 <br>
 
 <div align="center">
-  <img src="../images/2-4/node_diagram.png" alt="Alt Text">
+  <img src="./images/2-4/node_diagram.png" alt="Alt Text">
   <br>
   <em>autoware-practiceのtrajectory_follower周りのノードダイアグラム</em>
 </div>
@@ -350,7 +350,7 @@ $$ \alpha: 現在の車両の向きとルックアヘッドポイントへの方
 $$ d: ルックアヘッド距離 $$
 
 <div align="center">
-  <img src="../images/2-4/pure_pursuit.png" alt="Pure Pursuit">
+  <img src="./images/2-4/pure_pursuit.png" alt="Pure Pursuit">
   <br>
   <em>pure pursuitの基本動作</em>
 </div>

diff --git a/docs/development/device-drivers.en.md b/docs/development/device-drivers.en.md
diff --git a/docs/development/device-drivers.ja.md b/docs/development/device-drivers.ja.md
diff --git a/...elopment/images/installation/autoware.png → docs/development/images/autoware.png b/...elopment/images/installation/autoware.png → docs/development/images/autoware.png
diff --git a/docs/development/images/installation/awsim.png b/docs/development/images/installation/awsim.png
diff --git a/docs/development/installation.en.md b/docs/development/installation.en.md
diff --git a/docs/development/requirements.en.md b/docs/development/requirements.en.md
diff --git a/docs/development/requirements.ja.md b/docs/development/requirements.ja.md
diff --git a/docs/development/requirements/index.md b/docs/development/requirements/index.md
@@ -0,0 +1,3 @@
+# 移動しました
+
+このページの内容は[こちら](../../setup/requirements.ja.md)に移動しました。
diff --git a/docs/development/visible-simulation.en.md b/docs/development/visible-simulation.en.md
diff --git a/docs/development/workspace.en.md → docs/development/workspace-usage.en.md b/docs/development/workspace.en.md → docs/development/workspace-usage.en.md
diff --git a/docs/development/workspace.ja.md → docs/development/workspace-usage.ja.md b/docs/development/workspace.ja.md → docs/development/workspace-usage.ja.md
@@ -63,9 +63,9 @@ Autowareのビルド後、以下のコマンドを実行します。
 ```
 
 下記の様な画面が表示されたら起動完了です。終了するにはターミナル上でCTRL + Cを入力します。
-![autoware](./images/installation/autoware.png)
+![autoware](./images/autoware.png)
 
-## [任意] Debug用にTerminalを3つ用意して開発したい場合
+## Debug用にTerminalを3つ用意して開発したい場合 (参考)
 
 `Alt+Ctrl+T`で１つ目のターミナルを立ち上げてから、以下のコマンド`Ctrl+Shift+P`で貼り付けた後に`Enter`で実行します。
 
@@ -104,9 +104,9 @@ ros2 topic pub --once /control/control_mode_request_topic std_msgs/msg/Bool '{da
 ```
 
 下記の様な画面が表示されたら起動完了です。終了するには各ターミナル上でCTRL + Cを入力します。
-![autoware](./images/installation/autoware.png)
+![autoware](./images/autoware.png)
 
-### [参考]ワークスペースの構成
+### ワークスペースの構成 (参考)
 
 参考までにこちらにワークスペースの構成を記載しておきます。
 

diff --git a/docs/getting-started.ja.md b/docs/getting-started.ja.md
@@ -6,16 +6,11 @@
 
 ## Ubuntu PC
 
-以下のスペックを満たすPCが必要ですが、推奨と書かれているものについては満たしていなくても動作することは可能です。ただし、推奨よりも低いスペックで動作させる場合ROS2側での実行速度が安定せずシミュレーションの実行の度に挙動が大きく変わってしまう可能性があります。
+[推奨環境](./setup/requirements.ja.md)を満たすPCが必要ですが、推奨と書かれているものについては満たしていなくても動作することは可能です。ただし、推奨よりも低いスペックで動作させる場合ROS2側での実行速度が安定せずシミュレーションの実行の度に挙動が大きく変わってしまう可能性があります。
 
-- OS: Ubuntu 22.04
-- CPU: Intel Core i5（4コア）以上（推奨）
-- メモリ:
-  - 8GB以上（最低）
-  - 16GB以上（推奨）
-- SSD: 60GB以上
+!!! warning
 
-Windows環境しかお持ちでない方は、Ubuntu22.04のインストールをお願いいたします。Windows環境と同じディスクにUbuntu環境を入れることもできますが、不慣れな場合Windows環境を破壊してしまう可能性があるため、新しく外付けまたは内蔵SSDを購入したうえでそちらへのインストールをすることを強くお勧めします。
+    Windows環境しかお持ちでない方は、Ubuntu22.04のインストールをお願いいたします。Windows環境と同じディスクにUbuntu環境を入れることもできますが、不慣れな場合Windows環境を破壊してしまう可能性があるため、新しく外付けまたは内蔵SSDを購入したうえでそちらへのインストールをすることを強くお勧めします。
 
 !!! info
 
@@ -25,21 +20,23 @@ Windows環境しかお持ちでない方は、Ubuntu22.04のインストール
 
 `Alt+Ctrl+T`でターミナルを立ち上げてから、以下に従ってコマンド`Ctrl+Shift+P`で貼り付けた後に`Enter`で実行します。
 
-[環境構築の説明ページ](./development/installation.md)
+- [ワークスペースのクローン](./setup/workspace-setup.ja.md)
+- [Dockerのインストール](./setup/docker.ja.md)
+- [AWSIMのダウンロード](./setup/headless-simulation.ja.md)
 
 ## 大会用リポジトリのビルド・実行
 
 環境構築が終わってから再度`Alt+Ctrl+T`でターミナルを立ち上げてから、以下に従ってコマンド`Ctrl+Shift+P`で貼り付けた後に`Enter`で実行します。
 
-[ワークスペースの使い方説明ページ](development/workspace.md)
+[ワークスペースの使い方説明ページ](./development/workspace-usage.ja.md)
 
 ## AIチャレンジでの開発の進め方
 
 ビルド・実行が終わってからメインモジュールの解説ページを読みながら実際に開発してみましょう。
 
-[メインモジュールについての解説ページ](development/workspace.md)
+[メインモジュールについての解説ページ](./development/main-module.ja.md)
 
-※AIチャレンジで開発する上でベースとなるソースコードは[大会用リポジトリ](https://github.com/AutomotiveAIChallenge/aichallenge-2024/tree/main/aichallenge/workspace/src/aichallenge_submit)内に提供されています。参加者の皆様にはこちらのコードをカスタマイズすることで開発を進めていただきますが、Autowareに不慣れな方はまずは[入門講座](./course/index.md)を一通りやっていただくことをお勧めします。
+※AIチャレンジで開発する上でベースとなるソースコードは[大会用リポジトリ](https://github.com/AutomotiveAIChallenge/aichallenge-2024/tree/main/aichallenge/workspace/src/aichallenge_submit)内に提供されています。参加者の皆様にはこちらのコードをカスタマイズすることで開発を進めていただきますが、Autowareに不慣れな方はまずは[入門講座](./course/index.ja.md)を一通りやっていただくことをお勧めします。
 
 ## 参考
 
@@ -66,7 +63,7 @@ git pull origin/main
 
 Q. `docker_run.sh: 行 35: rocker: コマンドが見つかりません`
 
-A. [rockerのインストール](./development/installation.md)をお願いします。
+A. [rockerのインストール](./setup/docker.ja.md)をお願いします。
 
 Q. `WARNING unable to detect os for base image 'aichallenge-2024-dev', maybe the base image does not exist`
 

diff --git a/docs/information.ja.md b/docs/information.ja.md
diff --git a/docs/assets/flowchart.drawio.en.svg → ...nformation/images/flowchart.drawio.en.svg b/docs/assets/flowchart.drawio.en.svg → ...nformation/images/flowchart.drawio.en.svg
diff --git a/docs/assets/flowchart.drawio.ja.svg → ...nformation/images/flowchart.drawio.ja.svg b/docs/assets/flowchart.drawio.ja.svg → ...nformation/images/flowchart.drawio.ja.svg
diff --git a/docs/competition/rules.en.md → docs/information/rules.en.md b/docs/competition/rules.en.md → docs/information/rules.en.md
diff --git a/docs/competition/rules.ja.md → docs/information/rules.ja.md b/docs/competition/rules.ja.md → docs/information/rules.ja.md
diff --git a/docs/information.en.md → docs/information/schedule.en.md b/docs/information.en.md → docs/information/schedule.en.md
@@ -2,7 +2,7 @@
 
 ## Overall Flow
 
-![flowchart](./assets/flowchart.drawio.svg)
+![flowchart](./images/flowchart.drawio.en.svg)
 
 ## Schedule
 

diff --git a/docs/information/schedule.ja.md b/docs/information/schedule.ja.md
@@ -0,0 +1,9 @@
+# 大会情報
+
+## 全体の流れ
+
+![flowchart](./images/flowchart.drawio.ja.svg)
+
+## 日程
+
+## 参加登録
diff --git a/docs/setup/docker.en.md b/docs/setup/docker.en.md
@@ -0,0 +1 @@
+# Install Virtual Environment
diff --git a/docs/development/installation.ja.md → docs/setup/docker.ja.md b/docs/development/installation.ja.md → docs/setup/docker.ja.md
@@ -1,25 +1,12 @@
-# 環境構築
+# 仮想環境のインストール
 
-## 推奨環境
+## 依存パッケージのインストール
 
-本大会で使用していただくPCの動作環境として以下を推奨しております。
-
-- OS: Ubuntu 22.04
-- CPU: Intel Core i5（4コア）以上（推奨）
-- メモリ:
-  - 8GB以上（最低）
-  - 16GB以上（推奨）
-- SSD: 60GB以上
-
-## aptパッケージ等のインストール
-
-まずは諸々最初に必要なパッケージをインストールします。
+まずは必要なライブラリをインストールします。
 
 ```bash
 sudo apt update
-sudo apt -y upgrade
-sudo apt install -y git python3-pip ca-certificates curl gnupg libvulkan1
-sudo ubuntu-drivers autoinstall
+sudo apt install -y python3-pip ca-certificates curl gnupg
 ```
 
 ## Dockerのインストール
@@ -67,7 +54,7 @@ echo export PATH='$HOME/.local/bin:$PATH' >> ~/.bashrc
 source ~/.bashrc
 ```
 
-## autoware環境のDockerイメージのpull
+## Autoware環境のDockerイメージ取得
 
 AIチャレンジで使用するautoware環境のDockerイメージを取得します。
 
@@ -89,22 +76,3 @@ Dockerイメージがダウンロードできていれば以下のような出
 REPOSITORY                                        TAG                       IMAGE ID       CREATED         SIZE
 ghcr.io/automotiveaichallenge/autoware-universe   humble-latest             30c59f3fb415   13 days ago     8.84GB
 ```
-
-## 大会用リポジトリのダウンロード
-
-リポジトリをクローンします。ここではホームディレクトリにクローンしますが、お好きなディレクトリに入れていただいても構いません。
-
-```bash
-cd ~
-git clone https://github.com/AutomotiveAIChallenge/aichallenge-2024.git
-```
-
-## AWSIMのダウンロード
-
-1. [Google Drive](https://drive.google.com/drive/folders/1ftIoamNGAet90sXeG48lKa89dkpVy45y) から最新の `AWSIM.zip` をダウンロードし、`aichallenge-2024/aichallenge/simulator` に展開します。
-
-2. パーミッションを図のように変更します。
-
-   ![パーミッション変更の様子](./images/installation/permmision.png)
-
-実行ファイルが`aichallenge-2024/aichallenge/simulator/AWSIM/AWSIM.x86_64`に存在していることを確認してください。
diff --git a/docs/setup/headless-simulation.en.md b/docs/setup/headless-simulation.en.md
@@ -0,0 +1 @@
+# Download Headless AWSIM
diff --git a/docs/setup/headless-simulation.ja.md b/docs/setup/headless-simulation.ja.md
@@ -0,0 +1,11 @@
+# 描画なしAWSIMのダウンロード
+
+## AWSIMのダウンロード
+
+1. [Google Drive](https://drive.google.com/drive/folders/1ftIoamNGAet90sXeG48lKa89dkpVy45y) から最新の `AWSIM.zip` をダウンロードし、`aichallenge-2024/aichallenge/simulator` に展開します。
+
+    実行ファイルが`aichallenge-2024/aichallenge/simulator/AWSIM/AWSIM.x86_64`に存在していることを確認してください。
+
+2. パーミッションを図のように変更します。
+
+    ![パーミッション変更の様子](./images/awsim-permmision.png)
diff --git a/docs/development/images/AWSIM&Autoware.png → docs/setup/images/awsim-and-autoware.png b/docs/development/images/AWSIM&Autoware.png → docs/setup/images/awsim-and-autoware.png
diff --git a/...opment/images/installation/permmision.png → docs/setup/images/awsim-permmision.png b/...opment/images/installation/permmision.png → docs/setup/images/awsim-permmision.png
diff --git a/...opment/images/installation/nvidia-smi.png → docs/setup/images/nvidia-smi.png b/...opment/images/installation/nvidia-smi.png → docs/setup/images/nvidia-smi.png
diff --git a/docs/setup/requirements.en.md b/docs/setup/requirements.en.md
@@ -0,0 +1 @@
+# Requirements
diff --git a/docs/setup/requirements.ja.md b/docs/setup/requirements.ja.md
@@ -0,0 +1,28 @@
+# 推奨環境
+
+本大会で使用していただくPCの動作環境として以下を推奨しております。
+
+!!! warning
+
+    Windows環境しかお持ちでない方は、Ubuntu22.04のインストールをお願いいたします。Windows環境と同じディスクにUbuntu環境を入れることもできますが、不慣れな場合Windows環境を破壊してしまう可能性があるため、新しく外付けまたは内蔵SSDを購入したうえでそちらへのインストールをすることを強くお勧めします。
+
+!!! info
+
+    Ubuntuのインストール方法については[こちらの記事](https://qiita.com/kiwsdiv/items/1fa6cf451225492b33d8)が参考になります。
+
+## 描画なしのAWSIMを使用する場合
+
+- OS: Ubuntu 22.04
+- CPU: Intel Core i5（4コア）以上（推奨）
+- メモリ:
+  - 8GB以上（最低）
+  - 16GB以上（推奨）
+- SSD: 60GB以上
+
+## 描画ありのAWSIMを使用する場合
+
+- OS: Ubuntu 22.04
+- CPU: Intel Corei7 (8 cores) or higher
+- GPU: NVIDIA Geforce VRAM 8 GB
+- Memory: 16 GB or more
+- Storage: SSD 60 GB or higher
diff --git a/docs/setup/visible-simulation.en.md b/docs/setup/visible-simulation.en.md
@@ -0,0 +1 @@
+# Download Visible AWSIM (optional)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# 移動しました

		このページの内容は[こちら](../../information/rules.ja.md)に移動しました。
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# 移動しました

		このページの内容は[こちら](../../setup/requirements.ja.md)に移動しました。