Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Consolidate common Connext installation pages #287

Merged
merged 2 commits into from
Jul 15, 2019
Merged

Consolidate common Connext installation pages #287

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d46a43
Consolidate common Connext installation pages
jacobperron Jun 25, 2019
ce762b5
Update links
jacobperron Jun 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update links 
Signed-off-by: Jacob Perron <[email protected]>
  • Loading branch information
@jacobperron
jacobperron committed Jun 25, 2019
commit ce762b5ffccfe8dc69fdbe3501233ab663069dd7
2 changes: 2 additions & 0 deletions source/Installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Installation

Installation/Crystal
Installation/Dashing
Installation/Install-Connext-Security-Plugins
Installation/Install-Connext-University-Eval

ROS 2 Installation Options
--------------------------
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Crystal/Linux-Development-Setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,12 +186,12 @@ Note: when using ``zsh`` you need to be in the directory of the script when sour

Now you can build as normal and support for RTI will be built as well.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`

Official binary packages from RTI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation <Install-Connext-University-Eval>`.
You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`.

After downloading, use ``chmod +x`` on the ``.run`` executable and then execute it.
Note that if you're installing to a system directory use ``sudo`` as well.
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Crystal/Linux-Install-Binary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Bouncy and earlier:
RTI Connext (version 5.3.1, amd64 only)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To use RTI Connext DDS there are full-suite install options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
To use RTI Connext DDS there are full-suite install options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`
or you can install a libraries-only Debian package of RTI Connext 5.3.1, available from the OSRF Apt respository
under a `non-commercial license <https://www.rti.com/ncl>`__.

Expand All @@ -134,7 +134,7 @@ All options need you to source the setup file to set the ``NDDSHOME`` environmen

Note: the above may need modification to match your RTI installation location

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

Try some examples
-----------------
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Crystal/Linux-Install-Debians.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,11 +138,11 @@ To install support for OpenSplice or RTI Connext on Bouncy:
By setting the environment variable ``RMW_IMPLEMENTATION=rmw_opensplice_cpp`` you can switch to use OpenSplice instead.
For ROS 2 releases Bouncy and newer, ``RMW_IMPLEMENTATION=rmw_connext_cpp`` can also be selected to use RTI Connext.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

.. _linux-ros1-add-pkgs:

`University, purchase or evaluation <Install-Connext-University-Eval>` options are also available for RTI Connext.
`University, purchase or evaluation <../Install-Connext-University-Eval>` options are also available for RTI Connext.

Install additional packages using ROS 1 packages
------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Crystal/OSX-Development-Setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Source the ``release.com`` file provided to set up the environment before buildi
RTI Connext (5.3)
^^^^^^^^^^^^^^^^^

If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`.
If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`.

You also need a Java runtime installed to run the RTI code generator, which you can get `here <https://support.apple.com/kb/DL1572?locale=en_US>`__.

Expand All @@ -210,7 +210,7 @@ The setup file and path will depend on your macOS version.

You may need to increase shared memory resources following https://community.rti.com/kb/osx510.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

.. _osx-development-setup-troubleshooting:

Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Crystal/OSX-Install-Binary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ For ROS 2 releases later than Ardent, set the ``OSPL_HOME`` environment variable
Enable Connext support
^^^^^^^^^^^^^^^^^^^^^^

To use RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
To use RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`

After installing, run RTI launcher and point it to your license file.

Expand All @@ -152,7 +152,7 @@ Set the ``NDDSHOME`` environment variable:

You may need to increase shared memory resources following https://community.rti.com/kb/osx510.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

Set up the ROS 2 environment
----------------------------
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Crystal/Windows-Development-Setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ where the exact paths may need to be slightly altered depending on where you sel
RTI Connext 5.3
^^^^^^^^^^^^^^^

If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`.
If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`.

After installing, use the RTI Launcher to load your license file.

Expand All @@ -217,7 +217,7 @@ Then before building ROS 2, set up the Connext environment:
Note that this path might need to be slightly altered depending on where you selected to install RTI Connext DDS, and which version of Visual Studio was selected.
The path above is the current default path as of version 5.3.1, but will change as the version numbers increment in the future.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

If you don't install any additional DDS vendors, ROS 2 will default to using eProsima's Fast-RTPS as the middleware.

Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Crystal/Windows-Install-Binary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ For ROS 2 releases later than Ardent, set the ``OSPL_HOME`` environment variable
RTI Connext
~~~~~~~~~~~

To use RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
To use RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`

After installing, run RTI launcher and point it to your license file.

Expand All @@ -129,7 +129,7 @@ Set the ``NDDSHOME`` environment variable:

set "NDDSHOME=C:\Program Files\rti_connext_dds-5.3.1"

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

Install OpenCV
^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Dashing/Linux-Development-Setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,12 @@ Note: when using ``zsh`` you need to be in the directory of the script when sour

Now you can build as normal and support for RTI will be built as well.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`

Official binary packages from RTI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`

After downloading, use ``chmod +x`` on the ``.run`` executable and then execute it.
Note that if you're installing to a system directory use ``sudo`` as well.
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Dashing/Linux-Install-Binary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ To use OpenSplice you can install a Debian package built by OSRF.
RTI Connext (version 5.3.1, amd64 only)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To use RTI Connext DDS there are full-suite install options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
To use RTI Connext DDS there are full-suite install options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`
or you can install a libraries-only Debian package of RTI Connext 5.3.1, available from the OSRF Apt respository
under a `non-commercial license <https://www.rti.com/ncl>`__.

Expand All @@ -119,7 +119,7 @@ All options need you to source the setup file to set the ``NDDSHOME`` environmen

Note: the above may need modification to match your RTI installation location

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

Try some examples
-----------------
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Dashing/Linux-Install-Debians.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,11 @@ To install support for OpenSplice or RTI Connext on Bouncy:
By setting the environment variable ``RMW_IMPLEMENTATION=rmw_opensplice_cpp`` you can switch to use OpenSplice instead.
For ROS 2 releases Bouncy and newer, ``RMW_IMPLEMENTATION=rmw_connext_cpp`` can also be selected to use RTI Connext.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

.. _Dashing_linux-ros1-add-pkgs:

`University, purchase or evaluation <Install-Connext-University-Eval>` options are also available for RTI Connext.
`University, purchase or evaluation <../Install-Connext-University-Eval>` options are also available for RTI Connext.

Install additional packages using ROS 1 packages
------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Dashing/OSX-Development-Setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Source the ``release.com`` file provided to set up the environment before buildi
RTI Connext (5.3)
^^^^^^^^^^^^^^^^^

If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`

You also need a Java runtime installed to run the RTI code generator, which you can get `here <https://support.apple.com/kb/DL1572?locale=en_US>`__.

Expand All @@ -220,7 +220,7 @@ The setup file and path will depend on your macOS version.

You may need to increase shared memory resources following https://community.rti.com/kb/osx510.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

.. _Dashing_osx-development-setup-troubleshooting:

Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Dashing/OSX-Install-Binary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ For ROS 2 releases later than Ardent, set the ``OSPL_HOME`` environment variable
Enable Connext support
^^^^^^^^^^^^^^^^^^^^^^

To use RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
To use RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`

After installing, run RTI launcher and point it to your license file.

Expand All @@ -155,7 +155,7 @@ Set the ``NDDSHOME`` environment variable:

You may need to increase shared memory resources following https://community.rti.com/kb/osx510.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

Set up the ROS 2 environment
----------------------------
Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Dashing/Windows-Development-Setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ where the exact paths may need to be slightly altered depending on where you sel
RTI Connext 5.3
^^^^^^^^^^^^^^^

If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`

After installing, use the RTI Launcher to load your license file.

Expand All @@ -215,7 +215,7 @@ Then before building ROS 2, set up the Connext environment:
Note that this path might need to be slightly altered depending on where you selected to install RTI Connext DDS, and which version of Visual Studio was selected.
The path above is the current default path as of version 5.3.1, but will change as the version numbers increment in the future.

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

If you don't install any additional DDS vendors, ROS 2 will default to using eProsima's Fast-RTPS as the middleware.

Expand Down
4 changes: 2 additions & 2 deletions source/Installation/Dashing/Windows-Install-Binary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ After unpacking, set the ``OSPL_HOME`` environment variable so that it points to
RTI Connext
~~~~~~~~~~~

To use RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
To use RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`

After installing, run RTI launcher and point it to your license file.

Expand All @@ -103,7 +103,7 @@ Set the ``NDDSHOME`` environment variable:

set "NDDSHOME=C:\Program Files\rti_connext_dds-5.3.1"

If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`.

Install OpenCV
^^^^^^^^^^^^^^
Expand Down
5 changes: 0 additions & 5 deletions source/Installation/Install-Connext-Security-Plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
.. redirect-from::

Install-Connext-Security-Plugins
Installation/Install-Connext-Security-Plugins

Installing Connext security plugins
===================================

Expand Down
2 changes: 1 addition & 1 deletion source/Installation/Install-Connext-University-Eval.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Installing University or Evaluation Versions of RTI Connext DDS
===============================================================

A libraries-only version of RTI Connext DDS 5.3.1 may be installed per the `installation instructions <Linux-Install-Debians>` for
A libraries-only version of RTI Connext DDS 5.3.1 may be installed per the `installation instructions <../Installation>` for
Debian/Ubuntu Linux (amd64) platforms only, under a `non-commercial license <https://www.rti.com/ncl>`__.

A full-suite installation of RTI Connext DDS is available for many additional platforms, for universities, evaluation, or purchase.
Expand Down