Skip to content

Commit 5bf0613

Browse files
committed
Polishes remaining documentation pages.
1 parent a46a256 commit 5bf0613

File tree

8 files changed

+30
-32
lines changed

8 files changed

+30
-32
lines changed

source/About.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
About this documentation
33
========================
44

5-
This documentation lives in http://github.com/ros2/ros2_documentation. Purely written in `ReST markup format <http://docutils.sourceforge.net/rst.html>`_, it is processed using Sphinx during ROSIndex builds. `Intersphinx support <Contributing/Inter-Sphinx-Support>` is readily available for cross-linking package specific entities.
5+
This documentation lives in http://github.com/ros2/ros2_documentation. Purely written in `ReST markup format <http://docutils.sourceforge.net/rst.html>`__, it is processed using Sphinx during ROSIndex builds. `Intersphinx support <Contributing/Inter-Sphinx-Support>` is readily available for cross-linking package specific entities.
66

77
Updates submission is currently handled through pull requests.

source/Contact.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If you try out ROS 2 and have feedback or questions, please get in touch with us
77
General/design discussion
88
-------------------------
99

10-
Discussions about ROS 2 development and plans are happening on the `“Next Generation ROS” Discourse category <http://discourse.ros.org/c/ng-ros>`__ (previously on the `sig-ng-ros (Special Interest Group on Next-Generation ROS) mailing list <https://groups.google.com/forum/?fromgroups#!forum/ros-sig-ng-ros>`__\ ).
10+
Discussions about ROS 2 development and plans are happening on the `“Next Generation ROS” Discourse category <http://discourse.ros.org/c/ng-ros>`__ (previously on the `sig-ng-ros (Special Interest Group on Next-Generation ROS) mailing list <https://groups.google.com/forum/?fromgroups#!forum/ros-sig-ng-ros>`__).
1111
Join us there and participate in the conversation.
1212

1313
If you'd like to contact us privately (e.g., if your question contains information sensitive to your organization or project), you can email us directly at ``[email protected]``.

source/Features.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11

2-
ROS 2 Features Status
3-
=====================
4-
2+
Features Status
3+
===============
54

65
The features listed below are available in the current ROS 2 release.
76
Unless otherwise specified, the features are available for all supported platforms (Ubuntu 18.04, OS X 10.12.x, Windows 10), DDS implementations (eProsima Fast RTPS, RTI Connext and ADLINK Opensplice) and programming language client libraries (C++ and Python).
@@ -65,7 +64,7 @@ For planned future development, see the `Roadmap <Roadmap>`.
6564
- `Demo <https://github.com/ros2/turtlebot2_demo>`__
6665
-
6766
* - Preliminary support for real-time code
68-
- `Demo <Tutorials/Real-Time-Programming>`\ , `demo <Tutorials/Allocator-Template-Tutorial>`
67+
- `Demo <Tutorials/Real-Time-Programming>`, `demo <Tutorials/Allocator-Template-Tutorial>`
6968
- Linux only. Not available for Fast RTPS.
7069
* - Preliminary support for "bare-metal" microcontrollers
7170
- `Wiki <https://github.com/ros2/freertps/wiki>`__

source/Related-Projects.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11

2-
ROS 2 Related Projects
3-
======================
2+
Related Projects
3+
================
44

55
.. toctree::
6-
:titlesonly:
76
:maxdepth: 1
87

98
Related-Projects/Intel-ROS2-Projects

source/Related-Projects/Intel-ROS2-Projects.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ Key Projects
99

1010
We are working on below ROS2 projects and publish source code through https://github.com/intel/ or ROS2 github repo gradually.
1111

12-
* `ROS2 OpenVINO <https://github.com/intel/ros2_openvino_toolkit>`_: ROS2 package for Intel® Visual Inference and Neural Network Optimization Toolkit to develop multiplatform computer vision solutions.
13-
* `ROS2 RealSense Camera <https://github.com/intel/ros2_intel_realsense>`_: ROS2 package for Intel® RealSense™ D400 serial cameras
14-
* `ROS2 Movidius NCS <https://github.com/intel/ros2_intel_movidius_ncs>`_: ROS2 package for object detection with Intel® Movidius™ Neural Computing Stick (NCS).
15-
* `ROS2 Object Messages <https://github.com/intel/ros2_object_msgs>`_: ROS2 messages for object.
16-
* `ROS2 Object Analytics <https://github.com/intel/ros2_object_analytics>`_: ROS2 package for object detection, tracking and 2D/3D localization.
17-
* `ROS2 Message Filters <https://github.com/ros2/message_filters>`_: ROS2 package for message synchronization with time stamp.
18-
* `ROS2 CV Bridge <https://github.com/ros-perception/vision_opencv/tree/ros2/cv_bridge>`_: ROS2 package to bridge with openCV.
19-
* `ROS2 Object Map <https://github.com/intel/ros2_object_map>`_: ROS2 package to mark tag of objects on map when SLAM based on information provided by ROS2 object analytics.
20-
* `ROS2 Moving Object <https://github.com/intel/ros2_moving_object>`_: ROS2 package to provide object motion information (like object velocity on x, y, z axis) based on information provided by ROS2 object analytics.
21-
* `ROS2 Grasp Library <https://github.com/intel/ros2_grasp_library>`_: Coming soon. ROS2 package for grasp position analysis, and compatible with `MoveIt <https://github.com/ros-planning/moveit.git>`_ grasp interfaces.
12+
* `ROS2 OpenVINO <https://github.com/intel/ros2_openvino_toolkit>`__: ROS2 package for Intel® Visual Inference and Neural Network Optimization Toolkit to develop multiplatform computer vision solutions.
13+
* `ROS2 RealSense Camera <https://github.com/intel/ros2_intel_realsense>`__: ROS2 package for Intel® RealSense™ D400 serial cameras
14+
* `ROS2 Movidius NCS <https://github.com/intel/ros2_intel_movidius_ncs>`__: ROS2 package for object detection with Intel® Movidius™ Neural Computing Stick (NCS).
15+
* `ROS2 Object Messages <https://github.com/intel/ros2_object_msgs>`__: ROS2 messages for object.
16+
* `ROS2 Object Analytics <https://github.com/intel/ros2_object_analytics>`__: ROS2 package for object detection, tracking and 2D/3D localization.
17+
* `ROS2 Message Filters <https://github.com/ros2/message_filters>`__: ROS2 package for message synchronization with time stamp.
18+
* `ROS2 CV Bridge <https://github.com/ros-perception/vision_opencv/tree/ros2/cv_bridge>`__: ROS2 package to bridge with openCV.
19+
* `ROS2 Object Map <https://github.com/intel/ros2_object_map>`__: ROS2 package to mark tag of objects on map when SLAM based on information provided by ROS2 object analytics.
20+
* `ROS2 Moving Object <https://github.com/intel/ros2_moving_object>`__: ROS2 package to provide object motion information (like object velocity on x, y, z axis) based on information provided by ROS2 object analytics.
21+
* `ROS2 Grasp Library <https://github.com/intel/ros2_grasp_library>`__: Coming soon. ROS2 package for grasp position analysis, and compatible with `MoveIt <https://github.com/ros-planning/moveit.git>`__ grasp interfaces.
2222

2323
Reference
2424
---------

source/Roadmap.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11

2-
ROS 2 Roadmap
3-
=============
2+
Roadmap
3+
=======
4+
5+
.. contents:: Table of Contents
6+
:depth: 2
7+
:local:
48

59
For more information on the design of ROS 2 please see `design.ros2.org <http://design.ros2.org>`__.
610
The core code for ROS 2 is on the `ros2 github organization <https://github.com/ros2>`__.
@@ -15,7 +19,7 @@ This is a list of the features targeted for development in the future.
1519
*Subject to change.*
1620

1721
Next release - D-turtle (June 2019)
18-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
22+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1923

2024
The `D-turtle meta ticket <https://github.com/ros2/ros2/issues/607>`__ on GitHub will in the near future enumerate the ongoing high level tasks as well as references specific tickets with more details.
2125

@@ -25,7 +29,6 @@ Future (in no specific order)
2529
Design / Concept
2630
~~~~~~~~~~~~~~~~
2731

28-
2932
* Support for non-ASCII strings in messages / services
3033
* Progress on migration plan
3134
* Reconsider 1-to-1 mapping of ROS nodes to DDS participants
@@ -34,7 +37,6 @@ Design / Concept
3437
Infrastructure and tools
3538
~~~~~~~~~~~~~~~~~~~~~~~~
3639

37-
3840
* Building
3941

4042
* Support to generate "fat" packages / archives
@@ -119,7 +121,6 @@ The trailing stars indicate the rough effort: 1 star for small, 2 stars for medi
119121
Port of existing ROS 1 functionality
120122
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
121123

122-
123124
* Perception metapackage
124125

125126
* Image pipeline
@@ -130,7 +131,7 @@ Port of existing ROS 1 functionality
130131
* Needs Actions
131132
* Moveit Maintainers are tracking: https://discourse.ros.org/t/moveit-maintainer-meeting-recap-july-25th-2018/5504
132133

133-
* Rqt
134+
* RQt
134135

135136
* convert more plugins [\* each when dependencies are available]
136137

@@ -139,7 +140,6 @@ Port of existing ROS 1 functionality
139140
Reducing Technical Debt
140141
~~~~~~~~~~~~~~~~~~~~~~~
141142

142-
143143
* Extend testing and resolve bugs in the current code base
144144

145145
* Waitset inconsistency

source/Troubleshooting.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
Troubleshooting
3-
---------------
3+
===============
44

55
Enable Multicast
6-
^^^^^^^^^^^^^^^^
6+
----------------
77

88
In order to communicate successfully via DDS, the used network interface has to be multicast enabled.
99
We've seen in past experiences that this might not necessarily be enabled by default (on Ubuntu or OSX) when using the loopback adapter.
@@ -23,9 +23,9 @@ In Terminal 2:
2323
ros2 multicast send
2424
2525
Import failing even with library present on the system
26-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26+
------------------------------------------------------
2727

2828
Sometimes ``rclpy`` fails to be imported because of some missing DLLs on your system.
29-
If so make sure to install all the dependencies listed in the "Installing prerequisites" sections of the installation instructions (`Windows <windows-install-binary-installing-prerequisites>`\ , `MacOS <osx-install-binary-installling-prerequisites>`\ ).
29+
If so make sure to install all the dependencies listed in the "Installing prerequisites" sections of the installation instructions (`Windows <windows-install-binary-installing-prerequisites>`, `MacOS <osx-install-binary-installling-prerequisites>`).
3030

3131
If you are installing from binaries, you may need to update your dependencies: they must be the same version as those used to build the binaries.

source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ ROS 2 is under heavy development.
4949

5050
You can check out the `tutorials page <Tutorials>` to see a range of examples of what the system can do in its current state, if it fits your project *today* depending on the exact requirement.
5151

52-
For details of the current features, see `Features <Features>`.
52+
For details of the current features, see `features status page <Features>`.
5353

5454
If migrating code from ROS to ROS 2, check `the migration guide <Contributing/Migration-Guide>`.
5555

0 commit comments

Comments
 (0)