Merge branch 'main' into precept

.github/sync-files.yaml

@@ -15,8 +15,23 @@
     - source: .github/workflows/spell-check-differential.yaml
     - source: .github/workflows/sync-files.yaml
     - source: .markdown-link-check.json
+      pre-commands: |
+        sd -s -- \
+        '     "pattern": "^http://localhost"' \
+        '     "pattern": "^https://www\\.autosar\\.org/*"
+            },
+            {
+              "pattern": "^http://localhost"' \
+          {source}
     - source: .markdownlint.yaml
     - source: .pre-commit-config-optional.yaml
     - 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/deploy-docs.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - galactic
     paths:
       - mkdocs.yaml
       - "**/*.md"
@@ -21,7 +22,7 @@ jobs:
   prevent-no-label-execution:
     uses: autowarefoundation/autoware-github-actions/.github/workflows/prevent-no-label-execution.yaml@v1
     with:
-      label: documentation
+      label: deploy-docs
 
   deploy-docs:
     needs: prevent-no-label-execution

.github/workflows/github-release.yaml

@@ -26,8 +26,8 @@ jobs:
             REF_NAME="${{ github.ref_name }}"
           fi
 
-          echo ::set-output name=ref-name::"$REF_NAME"
-          echo ::set-output name=tag-name::"${REF_NAME#beta/}"
+          echo "ref-name=$REF_NAME" >> $GITHUB_OUTPUT
+          echo "tag-name=${REF_NAME#beta/}" >> $GITHUB_OUTPUT
 
       - name: Check out repository
         uses: actions/checkout@v3
@@ -39,7 +39,7 @@ jobs:
         id: set-target-name
         run: |
           if [[ "${{ steps.set-tag-name.outputs.ref-name }}" =~ "beta/" ]]; then
-            echo ::set-output name=target-name::"${{ steps.set-tag-name.outputs.ref-name }}"
+            echo "target-name=${{ steps.set-tag-name.outputs.ref-name }}" >> $GITHUB_OUTPUT
           fi
 
       - name: Create a local tag for beta branches
@@ -62,7 +62,7 @@ jobs:
             verb=edit
           fi
 
-          echo ::set-output name=verb::"$verb"
+          echo "verb=$verb" >> $GITHUB_OUTPUT
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

.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 }}

.github/workflows/pre-commit.yaml

@@ -5,7 +5,7 @@ on:
 
 jobs:
   pre-commit:
-    if: ${{ github.event.repository.private }}
+    if: ${{ github.event.repository.private }} # Use pre-commit.ci for public repositories
     runs-on: ubuntu-latest
     steps:
       - name: Generate token
@@ -20,11 +20,6 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.ref }}
 
-      - name: Set git config
-        uses: autowarefoundation/autoware-github-actions/set-git-config@v1
-        with:
-          token: ${{ steps.generate-token.outputs.token }}
-
       - name: Run pre-commit
         uses: autowarefoundation/autoware-github-actions/pre-commit@v1
         with:

.markdown-link-check.json

@@ -1,9 +1,15 @@
 {
   "aliveStatusCodes": [200, 206, 403],
   "ignorePatterns": [
+    {
+      "pattern": "^https://www\\.autosar\\.org/*"
+    },
     {
       "pattern": "^http://localhost"
     },
+    {
+      "pattern": "^http://127\\.0\\.0\\.1"
+    },
     {
       "pattern": "^https://github.com/.*/discussions/new"
     }

.markdownlint.yaml

@@ -3,6 +3,8 @@ default: true
 MD013: false
 MD024:
   siblings_only: true
+MD029:
+  style: ordered
 MD033: false
 MD041: false
 MD046: false

.pre-commit-config-optional.yaml

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

.pre-commit-config.yaml

@@ -1,10 +1,10 @@
 ci:
-  autofix_commit_msg: "ci(pre-commit): autofix"
+  autofix_commit_msg: "style(pre-commit): autofix"
   autoupdate_commit_msg: "ci(pre-commit): autoupdate"
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
       - id: check-json
       - id: check-merge-conflict
@@ -19,29 +19,29 @@ repos:
         args: [--markdown-linebreak-ext=md]
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.32.1
+    rev: v0.32.2
     hooks:
       - id: markdownlint
         args: [-c, .markdownlint.yaml, --fix]
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.7.1
+    rev: v3.0.0-alpha.4
     hooks:
       - id: prettier
 
   - repo: https://github.com/adrienverge/yamllint
-    rev: v1.27.1
+    rev: v1.28.0
     hooks:
       - id: yamllint
         exclude: .*.param.yaml
 
   - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: v0.8.0.4
+    rev: v0.9.0.2
     hooks:
       - id: shellcheck
 
   - repo: https://github.com/scop/pre-commit-shfmt
-    rev: v3.5.1-1
+    rev: v3.6.0-1
     hooks:
       - id: shfmt
         args: [-w, -s, -i=4]

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

README.md

@@ -1,5 +1,9 @@
-# autoware-documentation
+# Autoware documentation
 
 - This repository contains the [MkDocs](https://www.mkdocs.org/) source files for the [Autoware documentation hosted on GitHub Pages](https://autowarefoundation.github.io/autoware-documentation/main/).
 - Since Autoware is made up of [multiple repositories](https://github.com/autowarefoundation/), a central documentation repository is important to make information accessible from a single place.
 - For more information about Autoware and its related repositories, refer to the [Autoware Foundation's organization profile](https://github.com/autowarefoundation/.github/blob/main/profile/README.md).
+
+## Contributions
+
+To contribute to this repository, see the [documentation guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/documentation-guidelines/).

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.