You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improve wording in Getting Started and other tutorials (backport #405) (#407)
* Improve wording in Getting Started and other tutorials (#405)
* Improve wording in Getting Started and other tutorials
* Fixup
* Improve README
* Address PR feedback
(cherry picked from commit d71d784)
* Switch from Rolling to Humble in text
Co-authored-by: Dave Coleman <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+31-28Lines changed: 31 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,16 @@
1
1
# MoveIt 2 Tutorials
2
2
3
-
**NOTE: This repository is a new fork from the [MoveIt 1 tutorials](https://ros-planning.github.io/moveit_tutorials/) and needs your help with porting old tutorials to ROS 2.** To claim a tutorial to support the port of, see the Issues list. Thanks!
3
+
This is the primary documentation for the MoveIt project.
4
4
5
-
[See the live MoveIt 2 tutorials here](https://moveit.picknik.ai/)
6
-
7
-
This is the primary documentation for the MoveIt project. We strongly encourage you to help improve MoveIt's documentation. Please consider reading the guidelines below for writing the best documentation and tutorials. However, if you are uncomfortable with any of the approaches, simply adding documentation text to your pull requests is better than nothing.
8
-
9
-
These tutorials use the [reStructuredText](http://www.sphinx-doc.org/en/stable/rest.html) format commonly used in the Sphinx "Python Documentation Generator". This unfortunately differs from the common Markdown format, but its advantage is that it supports embedding code directly from source files for inline code tutorials.
5
+
## Contributing
10
6
11
-
All content in this repository is open source and released under the [BSD License v3](https://opensource.org/licenses/BSD-3-Clause). Each individual source code file should contain a copy of the license.
7
+
We strongly encourage you to help improve MoveIt's documentation. Please consider helping improve the tutorials, port old ones from ROS 1, and write new tutorials. We recommend you read the quality standards below as well as the [How to Write a MoveIt Tutorial](https://moveit.picknik.ai/main/doc/how_to_contribute/how_to_write_tutorials.html) page.
12
8
13
-
This repository is currently built automatically by Github Actions:
If you find an issue with the tutorials you are not able to fix yourself, please [open an issue on GitHub](https://github.com/ros-planning/moveit2_tutorials/issues/new) or open a PR with proposed changes.
23
10
24
11
## Helping with Porting Tutorials to ROS 2
25
-
An issue has been created for each tutorial to be ported to Foxy. At the top of each tutorial there is a tag: ":moveit1:", remove the tag
12
+
13
+
An issue has been created for each tutorial to be ported to ROS 2. At the top of each tutorial there is a tag: ":moveit1:", remove the tag
26
14
after the tutorial has been successfully updated.
27
15
28
16
Below are some links to help with the ports.
@@ -31,9 +19,6 @@ Below are some links to help with the ports.
@@ -58,7 +43,7 @@ Configure and build the workspace:
58
43
59
44
If you want to test the tutorials by generating the html pages locally on your machine, you can use the ``build_locally`` script by issuing the following commands in the root of the moveit2_tutorials package:
60
45
61
-
export ROS_DISTRO=rolling # 20.04
46
+
export ROS_DISTRO=humble # 20.04
62
47
63
48
cd $COLCON_WS/src/moveit2_tutorials
64
49
source /opt/ros/$ROS_DISTRO/setup.bash
@@ -71,12 +56,10 @@ The local website ``<LOCAL_PACKAGE_PATH>/build/html/index.html`` should automati
71
56
-*noinstall* skip the dependencies install step to speed up the script
72
57
-*loop* automatically rebuild the html if a change is detected
73
58
74
-
## Contributing
75
-
76
-
We rely on the community to keep these tutorials up to date and bug free. If you find an issue with the tutorials please [open an issue on GitHub](https://github.com/ros-planning/moveit2_tutorials/issues/new) or open a PR with proposed changes.
77
-
78
59
### Formatting and Style
79
60
61
+
These tutorials use the [reStructuredText](http://www.sphinx-doc.org/en/stable/rest.html) format commonly used in the Sphinx "Python Documentation Generator". This unfortunately differs from the common Markdown format, but its advantage is that it supports embedding code directly from source files for inline code tutorials.
62
+
80
63
**Code Formatting**
81
64
82
65
* These tutorials use the same [style guidelines](http://moveit.ros.org/documentation/contributing/code/) as the MoveIt project. When modifying or adding to these tutorials, it is required that code is auto formatted using [clang-format](http://moveit.ros.org/documentation/contributing/code/). To check and apply our style guidelines we use [pre-commit](https://pre-commit.com/).
@@ -147,3 +130,23 @@ To embed a video that is included in this repository, you also will use raw html
147
130
Note that the video file is in the `_static/videos` folder instead of the same folder.
148
131
149
132
[External Documentation on <video> tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video)
133
+
134
+
## License
135
+
136
+
All content in this repository is open source and released under the [BSD License v3](https://opensource.org/licenses/BSD-3-Clause). Each individual source code file should contain a copy of the license.
137
+
138
+
## Build Status
139
+
140
+
This repository is currently built automatically by Github Actions:
Copy file name to clipboardExpand all lines: doc/how_to_contribute/how_to_write_tutorials.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ How to Write a MoveIt Tutorial
4
4
This guide explains how to write tutorials for the MoveIt documentation.
5
5
Tutorials are one of the most useful contributions you can make because they are the first thing many new users see.
6
6
This guide is intended for any contributor who wants to submit a new tutorial.
7
-
If you are looking for a how-to guide for using MoveIt, you can find one :doc:`here </doc/how_to_guides/how_to_guides>`.
7
+
There are many additional quality standards and how-tos for contributing to the tutorials located in this repository's `README <https://github.com/ros-planning/moveit2_tutorials/blob/main/README.md>`_.
Copy file name to clipboardExpand all lines: doc/tutorials/getting_started/getting_started.rst
+16-6Lines changed: 16 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
Getting Started
2
2
===============
3
3
4
-
This tutorial will install MoveIt 2 and create a workspace sandbox to run the tutorials and example robot.
4
+
Here we will setup your environment for best running the tutorials. This will create a Colcon workspace, download all of the latest MoveIt source code, and build everything from source to ensure you have the latest fixes and improvements.
5
5
6
6
Install ROS 2 and Colcon
7
7
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -40,12 +40,15 @@ For tutorials you will need to have a :ros_documentation:`colcon <Tutorials/Colc
40
40
41
41
mkdir -p ~/ws_moveit2/src
42
42
43
-
Download MoveIt 2 Tutorials Source
44
-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
45
-
Move into your colcon workspace and pull the MoveIt 2 tutorials source: ::
43
+
Download Source Code of MoveIt and the Tutorials
44
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
45
+
Move into your colcon workspace and pull the MoveIt tutorials source: ::
46
46
47
47
cd ~/ws_moveit2/src
48
48
git clone https://github.com/ros-planning/moveit2_tutorials -b main
49
+
50
+
Next we will download the source code for the rest of MoveIt: ::
@@ -59,6 +62,13 @@ The next command will configure your colcon workspace: ::
59
62
cd ~/ws_moveit2
60
63
colcon build --mixin release
61
64
65
+
This build command will likely take a long time (20+ minutes) depending on your computer speed and amount of RAM available (we recommend 32 GB). If you are short on computer memory or generally your build is struggling to complete on your computer, you can append the argument ``--parallel-workers 1`` to the colcon command above.
66
+
67
+
If everything goes well, you should see the message "finished". If you have problems, try re-checking your `ROS Installation <https://docs.ros.org/en/humble/Installation.html>`_.
68
+
69
+
Setup Your Colcon Workspace
70
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
71
+
62
72
Source the colcon workspace: ::
63
73
64
74
source ~/ws_moveit2/install/setup.bash
@@ -72,5 +82,5 @@ Optional: add the previous command to your ``.bashrc``: ::
72
82
colcon workspace at a time, but we recommend it for simplicity.
73
83
74
84
Next Step
75
-
^^^^^^^^^^
76
-
:doc:`Visualize a robot with the interactive motion planning plugin for RViz </doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial>`
85
+
^^^^^^^^^
86
+
Nice job! Next we will :doc:`Visualize a robot with the interactive motion planning plugin for RViz </doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial>`
Copy file name to clipboardExpand all lines: doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ MoveIt Quickstart in RViz
3
3
.. image:: rviz_plugin_head.png
4
4
:width:700px
5
5
6
-
This tutorial will quickly get you motion planning using MoveIt via RViz and the MoveIt plugin. Rviz is the primary visualizer in ROS and an incredibly useful tool for debugging robotics. The MoveIt Rviz plugin allows you to setup virtual environments (scenes), create start and goal states for the robot interactively, test various motion planners, and visualize the output. Let's go!
6
+
This tutorial will teach you how to create motion plans in MoveIt using RViz and the MoveIt Display plugin. Rviz is the primary visualizer in ROS and a very useful tool for debugging robotics. The MoveIt Display plugin allows you to setup virtual environments (planning scenes), create start and goal states for the robot interactively, test various motion planners, and visualize the output. Let's get started!
Copy file name to clipboardExpand all lines: doc/tutorials/visualizing_in_rviz/visualizing_in_rviz.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
Visualizing In RViz
2
2
===================
3
3
4
-
This tutorial will introduce you to a tool that can help you quickly understand what your MoveIt program is doing by rendering visualizations in RViz.
4
+
This tutorial will introduce you to a tool that can help you more easily understand what your MoveIt application is doing by rendering visualizations in RViz.
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?v=4&size=40){kind=avatar}
0 commit comments