This tutorial describes how to modify an existing tutorial or add a new tutorial.
All tutorials exist in a GitHub repository: https://github.com/osrf/gazebo_tutorials.
This repository contains a
manifest.xml that holds meta-information about
the tutorials, and a set of directories that hold the tutorial contents.
Follow these steps to change an existing tutorial.
Click the Edit button located at the top-right of the tutorial you want to modify.
This will bring you to the tutorial source on GitHub.
Click the Edit button on the file (see GitHub help page).
Make your changes to the file using Markdown syntax.
Choose to create a new branch and start a pull request.
Type a commit message to describe your changes and propose file change.
The steps for creating a new tutorial are similar to those for modifying a tutorial.
Add a new top-level directory to hold the contents of your tutorial.
Populate the new directory with a text file formated using markdown and any other supporting material.
Add a new
<tutorial>...</tutorial> block to
ref attribute of the
<tutorial> is unique and contains no special characters.
<description> should be very short.
Set the minimum and maximum version of gazebo for which the specified markdown file is applicable. For example:
<markdown version="1.9">...: Only version 1.9
<markdown version="1.9+">...: All versions 1.9 and above
<markdown version="1.9-2.0">...: All versions between 1.9 and 2.0, inclusive.
It is possible to have multiple markdown files for different versions of Gazebo. Just add multiple
<markdown> tags that reference different markdown files.
Add the new tutorial to an existing
<category>, located toward the bottom of the
manifest.xml file. Create a new category if you tutorial does not belong in an existing category.
Create a pull-request back to the
Your pull-request will be reviewed, during which time you may be asked to make changes.
Once accepted, your pull-request will be merged into the repository. Your changes should appear on the main gazebo website in a few minutes.
During development of new tutorials, or when modifying existing tutorials,
it is often desirable to visualize the tutorial before submitting
a pull-request. Tutorials from a specific branch of the
gazebo_tutorials repository may be visualized on
http://gazebosim.org/tutorials using the
For example, let us suppose you have made modifications to the install
tutorial in a branch called
my_install. Once this branch has been pushed
to GitHub, you may visualize your work with