Added description to tutorials and added a tutorials.yaml (gazebosim#66)

* Added description to tutorials and added a tutorials.yaml

Signed-off-by: ahcorde <[email protected]>

* Update acropolis/index.yaml

Signed-off-by: ahcorde <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>

* Update blueprint/index.yaml

Signed-off-by: ahcorde <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>

* Update citadel/index.yaml

Signed-off-by: ahcorde <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>

Author: ahcorde

acropolis/index.yaml

@@ -18,9 +18,12 @@ pages:
   - name: install
     title: Install
     file: install.md
+    description: Citadel installation instructions
   - name: ros_integration
     title: ROS Integration
     file: ros_integration.md
+    description: This tutorial details how to interface with ROS, enabling the ability to use tools such as Rviz for robot or sensor visualization.
   - name: comparison
     title: Feature Comparison
     file: comparison.md
+    description: A list of features present in Gazebo-classic and the status of their migration to Ignition.

blueprint/index.yaml

@@ -18,21 +18,28 @@ pages:
   - name: install
     title: Install
     file: install.md
+    description: Blueprint installation instructions
   - name: ros_integration
     title: ROS Integration
     file: ros_integration.md
+    description: This tutorial details how to interface with ROS, enabling the ability to use tools such as Rviz for robot or sensor visualization.
   - name: comparison
     title: Feature Comparison
     file: comparison.md
+    description: A list of features present in Gazebo-classic and the status of their migration to Ignition.
   - name: gui
     title: Understanding the GUI
     file: GUI_tutorial.md
+    description: This guide is an introduction to the Ignition Graphical User Interface (GUI).
   - name: manipulating_models
     title: Manipulating Models
     file: Manipulating_models.md
+    description: This tutorial will walk you through using various plugins to assist model and scene manipulation in the Ignition GUI.
   - name: fuel_insert
     title: Model Insertion from Fuel
     file: Model_insertion_fuel.md
+    description: Ignition Fuel hosts hundreds of models that can easily be added to a world running in the Ignition GUI.
   - name: hotkeys
     title: Keyboard Shortcuts
     file: hotkeys.md
+    description: Ignition keyboard shortcuts

citadel/index.yaml

@@ -18,6 +18,7 @@ pages:
   - name: install
     title: Install
     file: install.md
+    description: Citadel installation instructions
     children:
       - name: install_ubuntu
         title: Binary Ubuntu Install
@@ -34,18 +35,24 @@ pages:
   - name: ros_integration
     title: ROS Integration
     file: ros_integration.md
+    description: This tutorial details how to interface with ROS, enabling the ability to use tools such as Rviz for robot or sensor visualization.
   - name: comparison
     title: Feature Comparison
     file: comparison.md
+    description: A list of features present in Gazebo-classic and the status of their migration to Ignition.
   - name: gui
     title: Understanding the GUI
     file: GUI_tutorial.md
+    description: This guide is an introduction to the Ignition Graphical User Interface (GUI).
   - name: manipulating_models
     title: Manipulating Models
     file: Manipulating_models.md
+    description: This tutorial will walk you through using various plugins to assist model and scene manipulation in the Ignition GUI.
   - name: fuel_insert
     title: Model Insertion from Fuel
     file: Model_insertion_fuel.md
+    description: Ignition Fuel hosts hundreds of models that can easily be added to a world running in the Ignition GUI.
   - name: hotkeys
     title: Keyboard Shortcuts
     file: hotkeys.md
+    description: Ignition keyboard shortcuts

tutorials.yaml

@@ -0,0 +1,8 @@
+# This file is an index of the pages to display on the documentation website
+# (https://ignitionrobotics.org/tutorials). The order of the pages in this file
+# is reflected on the website's left sidebar.
+
+releases:
+  - citadel
+  - blueprint
+  - acropolis