docs: add documentation tree structure (#14)

* docs: add documentation tree structure Signed-off-by: Kenji Miyake <[email protected]> * docs: add an empty page of contribution guidelines for Docker Signed-off-by: Kenji Miyake <[email protected]> * docs: add an empty page of contribution guidelines for ROS 2 interfaces Signed-off-by: Kenji Miyake <[email protected]>
autowarefoundation · Jan 21, 2022 · 7a11e53 · 7a11e53
1 parent 88163d1
commit 7a11e53
Show file tree

Hide file tree

Showing 75 changed files with 426 additions and 1 deletion.
diff --git a/docs/.pages 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,5 @@
+# Topic namespaces
+
+!!! warning
+
+    Under Construction
diff --git a/docs/contributing/discussion-guidelines/.pages 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
@@ -0,0 +1,5 @@
+# Discussion guidelines
+
+!!! warning
+
+    Under Construction
diff --git a/docs/contributing/documentation-guidelines/.pages 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
@@ -0,0 +1,5 @@
+# Documentation guidelines
+
+!!! warning
+
+    Under Construction
diff --git a/docs/contributing/index.md 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
@@ -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
@@ -0,0 +1,5 @@
+# Pull request guidelines
+
+!!! warning
+
+    Under Construction
diff --git a/docs/contributing/testing-guidelines/.pages 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
@@ -0,0 +1,5 @@
+# Testing guidelines
+
+!!! warning
+
+    Under Construction
diff --git a/docs/design/.pages 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
@@ -0,0 +1,2 @@
+nav:
+  - index.md
diff --git a/docs/design/ad-api/index.md 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
@@ -0,0 +1,2 @@
+nav:
+  - index.md
diff --git a/docs/design/component-interfaces/index.md 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,5 @@
+# Repository structure
+
+!!! warning
+
+    Under Construction
diff --git a/docs/design/index.md 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
@@ -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
@@ -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
@@ -0,0 +1,5 @@
+# Help
+
+!!! warning
+
+    Under Construction
diff --git a/docs/help/support-guidelines.md 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
@@ -0,0 +1,2 @@
+nav:
+  - index.md
diff --git a/docs/how-to-guides/index.md 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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,5 @@
+# Docker installation
+
+!!! warning
+
+    Under Construction
diff --git a/docs/installation/autoware/index.md 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
@@ -0,0 +1,5 @@
+# Local installation
+
+!!! warning
+
+    Under Construction
diff --git a/docs/installation/index.md b/docs/installation/index.md
@@ -0,0 +1,7 @@
+# Installation
+
+!!! warning
+
+    Under Construction
+
+## Supported platforms