Merge pull request #41 from tier4/sync-upstream

chore: sync upstream

.github/sync-files.yaml

@@ -28,3 +28,10 @@
     - source: .prettierignore
     - source: .prettierrc.yaml
     - source: .yamllint.yaml
+
+- repository: autowarefoundation/autoware-documentation
+  files:
+    - source: mkdocs-base.yaml
+      dest: mkdocs.yaml
+      pre-commands: |
+        sd "  - macros" "  - macros:\n      include_yaml:\n        - autoware_interfaces: yaml/autoware-interfaces.yaml" {source}

.github/workflows/pre-commit-optional.yaml

@@ -9,8 +9,11 @@ jobs:
     steps:
       - name: Check out repository
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Run pre-commit
         uses: autowarefoundation/autoware-github-actions/pre-commit@v1
         with:
           pre-commit-config: .pre-commit-config-optional.yaml
+          base-branch: origin/${{ github.base_ref }}

.pre-commit-config-optional.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/tcort/markdown-link-check
-    rev: v3.11.1
+    rev: v3.11.2
     hooks:
       - id: markdown-link-check
         args: [--quiet, --config=.markdown-link-check.json]

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[email protected].
+<[email protected]>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

docs/.pages

@@ -4,6 +4,8 @@ nav:
   - tutorials
   - how-to-guides
   - design
+  - Reference HW: reference-hw
   - contributing
   - datasets
   - support
+  - Competitions: autoware-competitions

docs/assets/js/mathjax.js

@@ -0,0 +1,16 @@
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true,
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex",
+  },
+};
+
+document$.subscribe(() => {
+  MathJax.typesetPromise();
+});

docs/autoware-competitions/index.md

@@ -0,0 +1,12 @@
+# Autoware Competitions
+
+This page is a collection of the links to the competitions that are related to the Autoware Foundation.
+
+|                             Title                             | Status  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| :-----------------------------------------------------------: | :-----: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <img src="images/autoware_challenge_2023.png" width = 640px > | Ongoing | **[Autoware / TIER IV Challenge 2023](https://autoware.org/autoware-challenge-2023)** <br> **Date:** May 15, 2023 - Nov. 1st, 2023 <br><br> As one of the main contributors of Autoware, TIER IV has been facing many difficult challenges through development, and TIER IV would like to sponsor a challenge to solve such engineering challenges. Any researchers, students, individuals or organizations are welcome to participate and submit their solution to any of the challenges we propose.                                                                                                                                                                                       |
+|    <img src="images/ai_challenge_2023.png" width = 640px >    | Ongoing | **[Japan Automotive AI Challenge 2023](https://www.jsae.or.jp/jaaic/)** <br> **Registration:** June 5, 2023 - July 14, 2023 <br>**Qualifiers:** July 3, 2023 - Aug. 31, 2023 <br>**Finals:** Nov. 12, 2023<br><br> In this competition, we focus on challenging tasks posed by autonomous driving in factory environments and aim to develop Autoware-based AD software that can overcome them. The qualifiers use the [digital twin autonomous driving simulator AWSIM](https://tier4.github.io/AWSIM/) to complete specific tasks within a virtual environment. Teams that make it to the finals have the opportunity to run their software on actual vehicles in a test course in Japan. |
+
+## Proposing New Competition
+
+If you want add a new competition to this page, please propose it in a TSC meeting and get confirmation from the AWF.

docs/contributing/coding-guidelines/ros-nodes/directory-structure.md

@@ -11,49 +11,64 @@
 ├─ config
 │   ├─ foo_ros.param.yaml
 │   └─ foo_non_ros.yaml
+├─ doc
+│   ├─ foo_document.md
+│   └─ foo_diagram.svg
 ├─ include
 │   └─ <package_name>
-│      └─ foo_public.hpp
+│       └─ foo_public.hpp
 ├─ launch
 │   ├─ foo.launch.xml
 │   └─ foo.launch.py
+├─ schema
+│   └─ foo_node.schema.json
 ├─ src
 │   ├─ foo_node.cpp
 │   ├─ foo_node.hpp
 │   └─ foo_private.hpp
 ├─ test
 │   └─ test_foo.cpp
 ├─ package.xml
-└─ CMakeLists.txt
+├─ CMakeLists.txt
+└─ README.md
 ```
 
-### config directory
+### Directory descriptions
 
-Place configuration files such as node parameters.
+#### `config`
 
+Place configuration files such as node parameters.
 For ROS parameters, use the extension `.param.yaml`.
 For non-ROS parameters, use the extension `.yaml`.
 
 Rationale: Since ROS parameters files are type-sensitive, they should not be the target of some code formatters and linters. In order to distinguish the file type, we use different file extensions.
 
-### include directory
+#### `doc`
+
+Place document files and link from README.
+
+#### `include`
 
 Place header files exposed to other packages. Do not place files directly under the `include` directory, but place files under the directory with the package name.
 This directory is used for mostly library headers. Note that many headers do not need to be placed here. It is enough to place the headers under the `src` directory.
 
 Reference: <https://docs.ros.org/en/rolling/How-To-Guides/Ament-CMake-Documentation.html#adding-files-and-headers>
 
-### launch directory
+#### `launch`
 
 Place launch files (`.launch.xml` and `.launch.py`).
 
-### src directory
+#### `schema`
+
+Place parameter definition files. See [parameters](./parameters.md) for details.
+
+#### `src`
 
 Place source files and private header files.
 
-### test directory
+#### `test`
 
-Place source files for testing.
+Place source files for testing. See [unit testing](../../testing-guidelines/unit-testing.md) for details.
 
 ## Python package
 

docs/contributing/coding-guidelines/ros-nodes/launch-files.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-Autoware use ROS2 launch system to startup the software. Please see the [official documentation](https://docs.ros.org/en/humble/Tutorials/Intermediate/Launch/Launch-Main.html) to get a basic understanding about ROS 2 Launch system if you are not familiar with it.
+Autoware use ROS 2 launch system to startup the software. Please see the [official documentation](https://docs.ros.org/en/humble/Tutorials/Intermediate/Launch/Launch-Main.html) to get a basic understanding about ROS 2 Launch system if you are not familiar with it.
 
 ## Guideline
 
@@ -60,7 +60,7 @@ In order to automatically load the newly added package when starting Autoware, y
 
 ## Parameter management
 
-Another purpose of introducing the `autoware_launch` repository is to facilitate the parameter management of Autoware. Thinking about this situation: if we want to integrate Autoware to a specific vehicle and modify parameters, we have to fork `autoware.universe` which also has a lot of code other than parameters and is frequently updated by developers. By intergrating these parameters in `autoware_launch`, we can customize the Autoware parameters just by forking `autoware_launch` repository. Taking the localization module as an examples:
+Another purpose of introducing the `autoware_launch` repository is to facilitate the parameter management of Autoware. Thinking about this situation: if we want to integrate Autoware to a specific vehicle and modify parameters, we have to fork `autoware.universe` which also has a lot of code other than parameters and is frequently updated by developers. By integrating these parameters in `autoware_launch`, we can customize the Autoware parameters just by forking `autoware_launch` repository. Taking the localization module as an examples:
 
 1. all the “launch parameters” for localization component is listed in the files under `autoware_launch/autoware_launch/config/localization`.
 2. the "launch parameters" file paths are set in the `autoware_launch/autoware_launch/launch/components/tier4_localization_component.launch.xml` file.