From 7a11e53400dd24eb7a17d902e841483467d2f8b0 Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Fri, 21 Jan 2022 22:50:08 +0900 Subject: [PATCH] docs: add documentation tree structure (#14) * docs: add documentation tree structure Signed-off-by: Kenji Miyake * docs: add an empty page of contribution guidelines for Docker Signed-off-by: Kenji Miyake * docs: add an empty page of contribution guidelines for ROS 2 interfaces Signed-off-by: Kenji Miyake --- docs/.pages | 8 +++++++ docs/contributing/.pages | 7 +++++++ docs/contributing/coding-guidelines/.pages | 4 ++++ docs/contributing/coding-guidelines/index.md | 7 +++++++ .../coding-guidelines/languages/.pages | 11 ++++++++++ .../coding-guidelines/languages/cmake.md | 5 +++++ .../coding-guidelines/languages/cpp.md | 5 +++++ .../coding-guidelines/languages/docker.md | 5 +++++ .../languages/github-actions.md | 5 +++++ .../coding-guidelines/languages/index.md | 5 +++++ .../coding-guidelines/languages/markdown.md | 5 +++++ .../languages/package-xml.md | 5 +++++ .../coding-guidelines/languages/python.md | 5 +++++ .../languages/ros2-interfaces.md | 5 +++++ .../languages/shell-scripts.md | 5 +++++ .../coding-guidelines/ros-nodes/.pages | 11 ++++++++++ .../ros-nodes/class-design.md | 5 +++++ .../ros-nodes/console-logging.md | 5 +++++ .../ros-nodes/coordinate-system.md | 5 +++++ .../ros-nodes/directory-structure.md | 5 +++++ .../coding-guidelines/ros-nodes/index.md | 5 +++++ .../ros-nodes/launch-files.md | 5 +++++ .../coding-guidelines/ros-nodes/naming.md | 5 +++++ .../coding-guidelines/ros-nodes/parameters.md | 5 +++++ .../ros-nodes/task-scheduling.md | 5 +++++ .../ros-nodes/topic-namespaces.md | 5 +++++ .../contributing/discussion-guidelines/.pages | 2 ++ .../discussion-guidelines/index.md | 5 +++++ .../documentation-guidelines/.pages | 2 ++ .../documentation-guidelines/index.md | 5 +++++ docs/contributing/index.md | 15 +++++++++++++ .../pull-request-guidelines/.pages | 2 ++ .../pull-request-guidelines/index.md | 5 +++++ docs/contributing/testing-guidelines/.pages | 2 ++ docs/contributing/testing-guidelines/index.md | 5 +++++ docs/design/.pages | 5 +++++ docs/design/ad-api/.pages | 2 ++ docs/design/ad-api/index.md | 5 +++++ docs/design/component-interfaces/.pages | 2 ++ docs/design/component-interfaces/index.md | 5 +++++ docs/design/configuration-management/.pages | 5 +++++ .../development-process.md | 5 +++++ docs/design/configuration-management/index.md | 5 +++++ .../release-process.md | 5 +++++ .../repository-structure.md | 5 +++++ docs/design/index.md | 11 ++++++++++ docs/help/.pages | 4 ++++ docs/help/docs-guide.md | 15 +++++++++++++ docs/help/index.md | 5 +++++ docs/help/support-guidelines.md | 5 +++++ docs/how-to-guides/.pages | 2 ++ docs/how-to-guides/index.md | 11 ++++++++++ docs/index.md | 21 ++++++++++++++++++- docs/installation/.pages | 5 +++++ docs/installation/autoware/.pages | 4 ++++ .../autoware/docker-installation.md | 5 +++++ docs/installation/autoware/index.md | 5 +++++ .../autoware/local-installation.md | 5 +++++ docs/installation/index.md | 7 +++++++ docs/installation/tools-for-developers/.pages | 2 ++ .../tools-for-developers/index.md | 5 +++++ docs/installation/tools-for-users/.pages | 2 ++ docs/installation/tools-for-users/index.md | 5 +++++ docs/tutorials/.pages | 4 ++++ docs/tutorials/index.md | 19 +++++++++++++++++ docs/tutorials/local-simulation/.pages | 5 +++++ .../closed-loop-simulation.md | 5 +++++ .../local-simulation/e2e-simulation.md | 5 +++++ docs/tutorials/local-simulation/index.md | 5 +++++ .../local-simulation/open-loop-simulation.md | 5 +++++ docs/tutorials/scenario-simulation/.pages | 5 +++++ .../closed-loop-simulation.md | 5 +++++ .../scenario-simulation/e2e-simulation.md | 5 +++++ docs/tutorials/scenario-simulation/index.md | 5 +++++ .../open-loop-simulation.md | 5 +++++ 75 files changed, 426 insertions(+), 1 deletion(-) create mode 100644 docs/.pages create mode 100644 docs/contributing/.pages create mode 100644 docs/contributing/coding-guidelines/.pages create mode 100644 docs/contributing/coding-guidelines/index.md create mode 100644 docs/contributing/coding-guidelines/languages/.pages create mode 100644 docs/contributing/coding-guidelines/languages/cmake.md create mode 100644 docs/contributing/coding-guidelines/languages/cpp.md create mode 100644 docs/contributing/coding-guidelines/languages/docker.md create mode 100644 docs/contributing/coding-guidelines/languages/github-actions.md create mode 100644 docs/contributing/coding-guidelines/languages/index.md create mode 100644 docs/contributing/coding-guidelines/languages/markdown.md create mode 100644 docs/contributing/coding-guidelines/languages/package-xml.md create mode 100644 docs/contributing/coding-guidelines/languages/python.md create mode 100644 docs/contributing/coding-guidelines/languages/ros2-interfaces.md create mode 100644 docs/contributing/coding-guidelines/languages/shell-scripts.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/.pages create mode 100644 docs/contributing/coding-guidelines/ros-nodes/class-design.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/console-logging.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/coordinate-system.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/directory-structure.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/index.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/launch-files.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/naming.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/parameters.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/task-scheduling.md create mode 100644 docs/contributing/coding-guidelines/ros-nodes/topic-namespaces.md create mode 100644 docs/contributing/discussion-guidelines/.pages create mode 100644 docs/contributing/discussion-guidelines/index.md create mode 100644 docs/contributing/documentation-guidelines/.pages create mode 100644 docs/contributing/documentation-guidelines/index.md create mode 100644 docs/contributing/index.md create mode 100644 docs/contributing/pull-request-guidelines/.pages create mode 100644 docs/contributing/pull-request-guidelines/index.md create mode 100644 docs/contributing/testing-guidelines/.pages create mode 100644 docs/contributing/testing-guidelines/index.md create mode 100644 docs/design/.pages create mode 100644 docs/design/ad-api/.pages create mode 100644 docs/design/ad-api/index.md create mode 100644 docs/design/component-interfaces/.pages create mode 100644 docs/design/component-interfaces/index.md create mode 100644 docs/design/configuration-management/.pages create mode 100644 docs/design/configuration-management/development-process.md create mode 100644 docs/design/configuration-management/index.md create mode 100644 docs/design/configuration-management/release-process.md create mode 100644 docs/design/configuration-management/repository-structure.md create mode 100644 docs/design/index.md create mode 100644 docs/help/.pages create mode 100644 docs/help/docs-guide.md create mode 100644 docs/help/index.md create mode 100644 docs/help/support-guidelines.md create mode 100644 docs/how-to-guides/.pages create mode 100644 docs/how-to-guides/index.md create mode 100644 docs/installation/.pages create mode 100644 docs/installation/autoware/.pages create mode 100644 docs/installation/autoware/docker-installation.md create mode 100644 docs/installation/autoware/index.md create mode 100644 docs/installation/autoware/local-installation.md create mode 100644 docs/installation/index.md create mode 100644 docs/installation/tools-for-developers/.pages create mode 100644 docs/installation/tools-for-developers/index.md create mode 100644 docs/installation/tools-for-users/.pages create mode 100644 docs/installation/tools-for-users/index.md create mode 100644 docs/tutorials/.pages create mode 100644 docs/tutorials/index.md create mode 100644 docs/tutorials/local-simulation/.pages create mode 100644 docs/tutorials/local-simulation/closed-loop-simulation.md create mode 100644 docs/tutorials/local-simulation/e2e-simulation.md create mode 100644 docs/tutorials/local-simulation/index.md create mode 100644 docs/tutorials/local-simulation/open-loop-simulation.md create mode 100644 docs/tutorials/scenario-simulation/.pages create mode 100644 docs/tutorials/scenario-simulation/closed-loop-simulation.md create mode 100644 docs/tutorials/scenario-simulation/e2e-simulation.md create mode 100644 docs/tutorials/scenario-simulation/index.md create mode 100644 docs/tutorials/scenario-simulation/open-loop-simulation.md diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 00000000000..05c17ec64ae --- /dev/null +++ b/docs/.pages @@ -0,0 +1,8 @@ +nav: + - Introduction: index.md + - installation + - tutorials + - how-to-guides + - design + - contributing + - help diff --git a/docs/contributing/.pages b/docs/contributing/.pages new file mode 100644 index 00000000000..cd0f83133e9 --- /dev/null +++ b/docs/contributing/.pages @@ -0,0 +1,7 @@ +nav: + - index.md + - coding-guidelines + - testing-guidelines + - documentation-guidelines + - pull-request-guidelines + - discussion-guidelines diff --git a/docs/contributing/coding-guidelines/.pages b/docs/contributing/coding-guidelines/.pages new file mode 100644 index 00000000000..7b092f71be5 --- /dev/null +++ b/docs/contributing/coding-guidelines/.pages @@ -0,0 +1,4 @@ +nav: + - index.md + - Language-specific coding guidelines: languages + - ROS nodes coding guidelines: ros-nodes diff --git a/docs/contributing/coding-guidelines/index.md b/docs/contributing/coding-guidelines/index.md new file mode 100644 index 00000000000..011ac8514bf --- /dev/null +++ b/docs/contributing/coding-guidelines/index.md @@ -0,0 +1,7 @@ +# Coding guidelines + +!!! warning + + Under Construction + +## Common guidelines diff --git a/docs/contributing/coding-guidelines/languages/.pages b/docs/contributing/coding-guidelines/languages/.pages new file mode 100644 index 00000000000..607efb582eb --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/.pages @@ -0,0 +1,11 @@ +nav: + - index.md + - cpp.md + - python.md + - shell-scripts.md + - markdown.md + - cmake.md + - package-xml.md + - ros2-interfaces.md + - docker.md + - github-actions.md diff --git a/docs/contributing/coding-guidelines/languages/cmake.md b/docs/contributing/coding-guidelines/languages/cmake.md new file mode 100644 index 00000000000..cbccf89eb54 --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/cmake.md @@ -0,0 +1,5 @@ +# CMake + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/languages/cpp.md b/docs/contributing/coding-guidelines/languages/cpp.md new file mode 100644 index 00000000000..7e987a8ce52 --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/cpp.md @@ -0,0 +1,5 @@ +# C++ + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/languages/docker.md b/docs/contributing/coding-guidelines/languages/docker.md new file mode 100644 index 00000000000..2071931d3dd --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/docker.md @@ -0,0 +1,5 @@ +# Docker + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/languages/github-actions.md b/docs/contributing/coding-guidelines/languages/github-actions.md new file mode 100644 index 00000000000..faee72648d7 --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/github-actions.md @@ -0,0 +1,5 @@ +# GitHub Actions + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/languages/index.md b/docs/contributing/coding-guidelines/languages/index.md new file mode 100644 index 00000000000..fca33299f20 --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/index.md @@ -0,0 +1,5 @@ +# Language-specific coding guidelines + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/languages/markdown.md b/docs/contributing/coding-guidelines/languages/markdown.md new file mode 100644 index 00000000000..98db593982e --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/markdown.md @@ -0,0 +1,5 @@ +# Markdown + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/languages/package-xml.md b/docs/contributing/coding-guidelines/languages/package-xml.md new file mode 100644 index 00000000000..ada54e057d3 --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/package-xml.md @@ -0,0 +1,5 @@ +# package.xml + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/languages/python.md b/docs/contributing/coding-guidelines/languages/python.md new file mode 100644 index 00000000000..821116d10cc --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/python.md @@ -0,0 +1,5 @@ +# Python + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/languages/ros2-interfaces.md b/docs/contributing/coding-guidelines/languages/ros2-interfaces.md new file mode 100644 index 00000000000..abfddfb48ff --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/ros2-interfaces.md @@ -0,0 +1,5 @@ +# ROS 2 interfaces + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/languages/shell-scripts.md b/docs/contributing/coding-guidelines/languages/shell-scripts.md new file mode 100644 index 00000000000..891b71e5235 --- /dev/null +++ b/docs/contributing/coding-guidelines/languages/shell-scripts.md @@ -0,0 +1,5 @@ +# Shell scripts + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/.pages b/docs/contributing/coding-guidelines/ros-nodes/.pages new file mode 100644 index 00000000000..850b79acbb5 --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/.pages @@ -0,0 +1,11 @@ +nav: + - index.md + - class-design.md + - console-logging.md + - coordinate-system.md + - directory-structure.md + - launch-files.md + - naming.md + - parameters.md + - task-scheduling.md + - topic-namespaces.md diff --git a/docs/contributing/coding-guidelines/ros-nodes/class-design.md b/docs/contributing/coding-guidelines/ros-nodes/class-design.md new file mode 100644 index 00000000000..4ce76c60e80 --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/class-design.md @@ -0,0 +1,5 @@ +# Class design + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/console-logging.md b/docs/contributing/coding-guidelines/ros-nodes/console-logging.md new file mode 100644 index 00000000000..e76373d1b1e --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/console-logging.md @@ -0,0 +1,5 @@ +# Console logging + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/coordinate-system.md b/docs/contributing/coding-guidelines/ros-nodes/coordinate-system.md new file mode 100644 index 00000000000..c298da9bedf --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/coordinate-system.md @@ -0,0 +1,5 @@ +# Coordinate system + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md b/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md new file mode 100644 index 00000000000..64f845dd056 --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md @@ -0,0 +1,5 @@ +# Directory structure + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/index.md b/docs/contributing/coding-guidelines/ros-nodes/index.md new file mode 100644 index 00000000000..e754141c28e --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/index.md @@ -0,0 +1,5 @@ +# ROS nodes coding guidelines + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/launch-files.md b/docs/contributing/coding-guidelines/ros-nodes/launch-files.md new file mode 100644 index 00000000000..c39bd75e891 --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/launch-files.md @@ -0,0 +1,5 @@ +# Launch files + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/naming.md b/docs/contributing/coding-guidelines/ros-nodes/naming.md new file mode 100644 index 00000000000..6873692fef7 --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/naming.md @@ -0,0 +1,5 @@ +# Topic namespaces + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/parameters.md b/docs/contributing/coding-guidelines/ros-nodes/parameters.md new file mode 100644 index 00000000000..f04837d6753 --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/parameters.md @@ -0,0 +1,5 @@ +# Parameters + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/task-scheduling.md b/docs/contributing/coding-guidelines/ros-nodes/task-scheduling.md new file mode 100644 index 00000000000..18e0866021e --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/task-scheduling.md @@ -0,0 +1,5 @@ +# Task scheduling + +!!! warning + + Under Construction diff --git a/docs/contributing/coding-guidelines/ros-nodes/topic-namespaces.md b/docs/contributing/coding-guidelines/ros-nodes/topic-namespaces.md new file mode 100644 index 00000000000..6873692fef7 --- /dev/null +++ b/docs/contributing/coding-guidelines/ros-nodes/topic-namespaces.md @@ -0,0 +1,5 @@ +# Topic namespaces + +!!! warning + + Under Construction diff --git a/docs/contributing/discussion-guidelines/.pages b/docs/contributing/discussion-guidelines/.pages new file mode 100644 index 00000000000..35fd5a113be --- /dev/null +++ b/docs/contributing/discussion-guidelines/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/contributing/discussion-guidelines/index.md b/docs/contributing/discussion-guidelines/index.md new file mode 100644 index 00000000000..bf20c0283e6 --- /dev/null +++ b/docs/contributing/discussion-guidelines/index.md @@ -0,0 +1,5 @@ +# Discussion guidelines + +!!! warning + + Under Construction diff --git a/docs/contributing/documentation-guidelines/.pages b/docs/contributing/documentation-guidelines/.pages new file mode 100644 index 00000000000..35fd5a113be --- /dev/null +++ b/docs/contributing/documentation-guidelines/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/contributing/documentation-guidelines/index.md b/docs/contributing/documentation-guidelines/index.md new file mode 100644 index 00000000000..a8f08173b9c --- /dev/null +++ b/docs/contributing/documentation-guidelines/index.md @@ -0,0 +1,5 @@ +# Documentation guidelines + +!!! warning + + Under Construction diff --git a/docs/contributing/index.md b/docs/contributing/index.md new file mode 100644 index 00000000000..3f8398267e8 --- /dev/null +++ b/docs/contributing/index.md @@ -0,0 +1,15 @@ +# Contributing + +!!! warning + + Under Construction + +## Contribution workflows + +### Issues + +### Discussions + +### Small pull requests + +### Large pull requests diff --git a/docs/contributing/pull-request-guidelines/.pages b/docs/contributing/pull-request-guidelines/.pages new file mode 100644 index 00000000000..35fd5a113be --- /dev/null +++ b/docs/contributing/pull-request-guidelines/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/contributing/pull-request-guidelines/index.md b/docs/contributing/pull-request-guidelines/index.md new file mode 100644 index 00000000000..3d8aa0fb086 --- /dev/null +++ b/docs/contributing/pull-request-guidelines/index.md @@ -0,0 +1,5 @@ +# Pull request guidelines + +!!! warning + + Under Construction diff --git a/docs/contributing/testing-guidelines/.pages b/docs/contributing/testing-guidelines/.pages new file mode 100644 index 00000000000..35fd5a113be --- /dev/null +++ b/docs/contributing/testing-guidelines/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/contributing/testing-guidelines/index.md b/docs/contributing/testing-guidelines/index.md new file mode 100644 index 00000000000..f58b651a245 --- /dev/null +++ b/docs/contributing/testing-guidelines/index.md @@ -0,0 +1,5 @@ +# Testing guidelines + +!!! warning + + Under Construction diff --git a/docs/design/.pages b/docs/design/.pages new file mode 100644 index 00000000000..d49b239909c --- /dev/null +++ b/docs/design/.pages @@ -0,0 +1,5 @@ +nav: + - index.md + - component-interfaces + - AD API: ad-api + - configuration-management diff --git a/docs/design/ad-api/.pages b/docs/design/ad-api/.pages new file mode 100644 index 00000000000..35fd5a113be --- /dev/null +++ b/docs/design/ad-api/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/design/ad-api/index.md b/docs/design/ad-api/index.md new file mode 100644 index 00000000000..91e28c21d10 --- /dev/null +++ b/docs/design/ad-api/index.md @@ -0,0 +1,5 @@ +# AD API + +!!! warning + + Under Construction diff --git a/docs/design/component-interfaces/.pages b/docs/design/component-interfaces/.pages new file mode 100644 index 00000000000..35fd5a113be --- /dev/null +++ b/docs/design/component-interfaces/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/design/component-interfaces/index.md b/docs/design/component-interfaces/index.md new file mode 100644 index 00000000000..d3170ab4fdc --- /dev/null +++ b/docs/design/component-interfaces/index.md @@ -0,0 +1,5 @@ +# Component interfaces + +!!! warning + + Under Construction diff --git a/docs/design/configuration-management/.pages b/docs/design/configuration-management/.pages new file mode 100644 index 00000000000..105157b3da2 --- /dev/null +++ b/docs/design/configuration-management/.pages @@ -0,0 +1,5 @@ +nav: + - index.md + - development-process.md + - repository-structure.md + - release-process.md diff --git a/docs/design/configuration-management/development-process.md b/docs/design/configuration-management/development-process.md new file mode 100644 index 00000000000..db5a38524d9 --- /dev/null +++ b/docs/design/configuration-management/development-process.md @@ -0,0 +1,5 @@ +# Development process + +!!! warning + + Under Construction diff --git a/docs/design/configuration-management/index.md b/docs/design/configuration-management/index.md new file mode 100644 index 00000000000..4602565cde8 --- /dev/null +++ b/docs/design/configuration-management/index.md @@ -0,0 +1,5 @@ +# Configuration management + +!!! warning + + Under Construction diff --git a/docs/design/configuration-management/release-process.md b/docs/design/configuration-management/release-process.md new file mode 100644 index 00000000000..cc75876d452 --- /dev/null +++ b/docs/design/configuration-management/release-process.md @@ -0,0 +1,5 @@ +# Release process + +!!! warning + + Under Construction diff --git a/docs/design/configuration-management/repository-structure.md b/docs/design/configuration-management/repository-structure.md new file mode 100644 index 00000000000..aa3d55ab39f --- /dev/null +++ b/docs/design/configuration-management/repository-structure.md @@ -0,0 +1,5 @@ +# Repository structure + +!!! warning + + Under Construction diff --git a/docs/design/index.md b/docs/design/index.md new file mode 100644 index 00000000000..27ee7d1cfe6 --- /dev/null +++ b/docs/design/index.md @@ -0,0 +1,11 @@ +# Design + +!!! warning + + Under Construction + +## Component interfaces + +## AD API + +## Configuration management diff --git a/docs/help/.pages b/docs/help/.pages new file mode 100644 index 00000000000..af1f2cda5c6 --- /dev/null +++ b/docs/help/.pages @@ -0,0 +1,4 @@ +nav: + - index.md + - support-guidelines.md + - docs-guide.md diff --git a/docs/help/docs-guide.md b/docs/help/docs-guide.md new file mode 100644 index 00000000000..6f7f3782d35 --- /dev/null +++ b/docs/help/docs-guide.md @@ -0,0 +1,15 @@ +# Docs guide + +!!! warning + + Under Construction + +This page explains documentations sites that are useful for Autoware and ROS development. + +## [The Autoware Foundation](https://www.autoware.org/) + +## [Autoware Documentation](https://autowarefoundation.github.io/autoware-documentation) (this site) + +## [Autoware Universe Documentation](https://autowarefoundation.github.io/autoware.universe) + +## [ROS Docs Guide](https://docs.ros.org/en/rolling/Docs-Guide.html) diff --git a/docs/help/index.md b/docs/help/index.md new file mode 100644 index 00000000000..8a8ae96beb6 --- /dev/null +++ b/docs/help/index.md @@ -0,0 +1,5 @@ +# Help + +!!! warning + + Under Construction diff --git a/docs/help/support-guidelines.md b/docs/help/support-guidelines.md new file mode 100644 index 00000000000..4ae6bfd7e0b --- /dev/null +++ b/docs/help/support-guidelines.md @@ -0,0 +1,5 @@ +# Support guidelines + +!!! warning + + Under Construction diff --git a/docs/how-to-guides/.pages b/docs/how-to-guides/.pages new file mode 100644 index 00000000000..35fd5a113be --- /dev/null +++ b/docs/how-to-guides/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/how-to-guides/index.md b/docs/how-to-guides/index.md new file mode 100644 index 00000000000..46ecf6764e2 --- /dev/null +++ b/docs/how-to-guides/index.md @@ -0,0 +1,11 @@ +# How-to guides + +!!! warning + + Under Construction + +- Write an Autoware package +- Add a message +- Debug Autoware +- Integrate Autoware with a real vehicle +- etc. diff --git a/docs/index.md b/docs/index.md index cb86fc356e3..2dce57c8e92 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1,20 @@ -# autoware-documentation +# Autoware Documentation + +!!! warning + + Under Construction + +## About Autoware + +Autoware is the world’s leading open-source software project for autonomous driving. Autoware is built on Robot Operating System (ROS) and enables commercial deployment of autonomous driving in a broad range of vehicles and applications. + +Please see [here](https://www.autoware.org/autoware) for more details. + +## Getting started + +- [Installation](installation) +- [Tutorials](tutorials) +- [How-to guides](how-to-guides) +- [Design](design) +- [Contributing](contributing) +- [Help](help) diff --git a/docs/installation/.pages b/docs/installation/.pages new file mode 100644 index 00000000000..87c5f9875a8 --- /dev/null +++ b/docs/installation/.pages @@ -0,0 +1,5 @@ +nav: + - index.md + - autoware + - tools-for-users + - tools-for-developers diff --git a/docs/installation/autoware/.pages b/docs/installation/autoware/.pages new file mode 100644 index 00000000000..e4ef1036208 --- /dev/null +++ b/docs/installation/autoware/.pages @@ -0,0 +1,4 @@ +nav: + - index.md + - local-installation.md + - docker-installation.md diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md new file mode 100644 index 00000000000..bb436018849 --- /dev/null +++ b/docs/installation/autoware/docker-installation.md @@ -0,0 +1,5 @@ +# Docker installation + +!!! warning + + Under Construction diff --git a/docs/installation/autoware/index.md b/docs/installation/autoware/index.md new file mode 100644 index 00000000000..292dd772203 --- /dev/null +++ b/docs/installation/autoware/index.md @@ -0,0 +1,5 @@ +# Installation of Autoware + +!!! warning + + Under Construction diff --git a/docs/installation/autoware/local-installation.md b/docs/installation/autoware/local-installation.md new file mode 100644 index 00000000000..06005ba2b7c --- /dev/null +++ b/docs/installation/autoware/local-installation.md @@ -0,0 +1,5 @@ +# Local installation + +!!! warning + + Under Construction diff --git a/docs/installation/index.md b/docs/installation/index.md new file mode 100644 index 00000000000..2fc0dd37325 --- /dev/null +++ b/docs/installation/index.md @@ -0,0 +1,7 @@ +# Installation + +!!! warning + + Under Construction + +## Supported platforms diff --git a/docs/installation/tools-for-developers/.pages b/docs/installation/tools-for-developers/.pages new file mode 100644 index 00000000000..35fd5a113be --- /dev/null +++ b/docs/installation/tools-for-developers/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/installation/tools-for-developers/index.md b/docs/installation/tools-for-developers/index.md new file mode 100644 index 00000000000..5f541ef509b --- /dev/null +++ b/docs/installation/tools-for-developers/index.md @@ -0,0 +1,5 @@ +# Installation of tools for developers + +!!! warning + + Under Construction diff --git a/docs/installation/tools-for-users/.pages b/docs/installation/tools-for-users/.pages new file mode 100644 index 00000000000..35fd5a113be --- /dev/null +++ b/docs/installation/tools-for-users/.pages @@ -0,0 +1,2 @@ +nav: + - index.md diff --git a/docs/installation/tools-for-users/index.md b/docs/installation/tools-for-users/index.md new file mode 100644 index 00000000000..de83d04050f --- /dev/null +++ b/docs/installation/tools-for-users/index.md @@ -0,0 +1,5 @@ +# Installation of tools for users + +!!! warning + + Under Construction diff --git a/docs/tutorials/.pages b/docs/tutorials/.pages new file mode 100644 index 00000000000..89e4ef764dd --- /dev/null +++ b/docs/tutorials/.pages @@ -0,0 +1,4 @@ +nav: + - index.md + - local-simulation + - scenario-simulation diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md new file mode 100644 index 00000000000..4906dc5e235 --- /dev/null +++ b/docs/tutorials/index.md @@ -0,0 +1,19 @@ +# Tutorials + +!!! warning + + Under Construction + +## Simulation methods + +### Local simulation + +### Scenario simulation + +## Simulation types + +### Closed-loop + +### Open-loop + +### E2E diff --git a/docs/tutorials/local-simulation/.pages b/docs/tutorials/local-simulation/.pages new file mode 100644 index 00000000000..a006bdfc501 --- /dev/null +++ b/docs/tutorials/local-simulation/.pages @@ -0,0 +1,5 @@ +nav: + - index.md + - closed-loop-simulation.md + - open-loop-simulation.md + - e2e-simulation.md diff --git a/docs/tutorials/local-simulation/closed-loop-simulation.md b/docs/tutorials/local-simulation/closed-loop-simulation.md new file mode 100644 index 00000000000..8ad89886adc --- /dev/null +++ b/docs/tutorials/local-simulation/closed-loop-simulation.md @@ -0,0 +1,5 @@ +# Closed-loop simulation + +!!! warning + + Under Construction diff --git a/docs/tutorials/local-simulation/e2e-simulation.md b/docs/tutorials/local-simulation/e2e-simulation.md new file mode 100644 index 00000000000..1b3d8ef78d9 --- /dev/null +++ b/docs/tutorials/local-simulation/e2e-simulation.md @@ -0,0 +1,5 @@ +# E2E simulation + +!!! warning + + Under Construction diff --git a/docs/tutorials/local-simulation/index.md b/docs/tutorials/local-simulation/index.md new file mode 100644 index 00000000000..3c089dc9a42 --- /dev/null +++ b/docs/tutorials/local-simulation/index.md @@ -0,0 +1,5 @@ +# Local simulation + +!!! warning + + Under Construction diff --git a/docs/tutorials/local-simulation/open-loop-simulation.md b/docs/tutorials/local-simulation/open-loop-simulation.md new file mode 100644 index 00000000000..5c702a292d3 --- /dev/null +++ b/docs/tutorials/local-simulation/open-loop-simulation.md @@ -0,0 +1,5 @@ +# Open loop simulation + +!!! warning + + Under Construction diff --git a/docs/tutorials/scenario-simulation/.pages b/docs/tutorials/scenario-simulation/.pages new file mode 100644 index 00000000000..a006bdfc501 --- /dev/null +++ b/docs/tutorials/scenario-simulation/.pages @@ -0,0 +1,5 @@ +nav: + - index.md + - closed-loop-simulation.md + - open-loop-simulation.md + - e2e-simulation.md diff --git a/docs/tutorials/scenario-simulation/closed-loop-simulation.md b/docs/tutorials/scenario-simulation/closed-loop-simulation.md new file mode 100644 index 00000000000..26ee6e01fba --- /dev/null +++ b/docs/tutorials/scenario-simulation/closed-loop-simulation.md @@ -0,0 +1,5 @@ +# Closed loop simulation + +!!! warning + + Under Construction diff --git a/docs/tutorials/scenario-simulation/e2e-simulation.md b/docs/tutorials/scenario-simulation/e2e-simulation.md new file mode 100644 index 00000000000..1b3d8ef78d9 --- /dev/null +++ b/docs/tutorials/scenario-simulation/e2e-simulation.md @@ -0,0 +1,5 @@ +# E2E simulation + +!!! warning + + Under Construction diff --git a/docs/tutorials/scenario-simulation/index.md b/docs/tutorials/scenario-simulation/index.md new file mode 100644 index 00000000000..3b6ba0b02c9 --- /dev/null +++ b/docs/tutorials/scenario-simulation/index.md @@ -0,0 +1,5 @@ +# Scenario simulation + +!!! warning + + Under Construction diff --git a/docs/tutorials/scenario-simulation/open-loop-simulation.md b/docs/tutorials/scenario-simulation/open-loop-simulation.md new file mode 100644 index 00000000000..5c702a292d3 --- /dev/null +++ b/docs/tutorials/scenario-simulation/open-loop-simulation.md @@ -0,0 +1,5 @@ +# Open loop simulation + +!!! warning + + Under Construction