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.

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

Remove installation landing page [Foxy] #1133

Merged
merged 3 commits into from
Feb 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
70 changes: 48 additions & 22 deletions source/Installation.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
.. _InstallationGuide:
.. _FoxyInstall:

Installation
============

Options for installing ROS 2 Foxy Fitzroy:

.. toctree::
:hidden:
:glob:

Installation/Summary
Installation/Linux-Development-Setup
Installation/Linux-Install-Binary
Installation/Linux-Install-Debians
Expand All @@ -21,36 +23,60 @@ Installation
Installation/Prerelease-Testing
Installation/DDS-Implementations

ROS 2 Installation Options
--------------------------
Binary packages
---------------

We provide ROS 2 binary packages for the following platforms:

* Linux (Ubuntu Focal(20.04))

* `Debian packages <Installation/Linux-Install-Debians>`
* `"fat" archive <Installation/Linux-Install-Binary>`

* `macOS <Installation/macOS-Install-Binary>`
* `Windows <Installation/Windows-Install-Binary>`


.. _building-from-source:

Building from source
--------------------

We support building ROS 2 from source on the following platforms:


* `Linux <Installation/Linux-Development-Setup>`
* `macOS <Installation/macOS-Development-Setup>`
* `Windows <Installation/Windows-Development-Setup>`


Multiple distributions of ROS 2 are supported at a time.
We recommend using the most recent release available when possible.
Which install should you choose?
--------------------------------

Select your ROS distribution
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installing from binary packages or from source will both result in a fully-functional and usable ROS 2 install.
Differences between the options depend on what you plan to do with ROS 2.

**Binary packages** are for general use and provide an already-built install of ROS 2.
This is great for people who want to dive in and start using ROS 2 as-is, right away.

+---------------------------------------------------------------------+-------------------------------------------------------------------+---------------------------------------------+
| `ROS 2 Dashing Diademata <../dashing/Installation/Summary.html>`__ | `ROS 2 Eloquent Elusor <../eloquent/Installation/Summary.html>`__ | `ROS 2 Foxy Fitzroy <Installation/Summary>` |
+---------------------------------------------------------------------+-------------------------------------------------------------------+---------------------------------------------+
| Released May 2019 | Released November 2019 | Released June 2020 |
+---------------------------------------------------------------------+-------------------------------------------------------------------+---------------------------------------------+
| Supported until May 2021 | Supported until November 2020 | Supported until May 2023 |
+---------------------------------------------------------------------+-------------------------------------------------------------------+---------------------------------------------+
Linux users have two options for installing binary packages:

- Debian packages
- "fat" archive

For more detailed descriptions of each release see `REP-2000 <https://www.ros.org/reps/rep-2000.html>`_
Installing from Debian packages is the recommended method.
It's more convenient because it installs its necessary dependencies automatically.
It also updates alongside regular system updates.

Why you might want an older distribution
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You may want to install an older distribution if you need ROS 2 to:
However, you need root access in order to install Debian packages.
If you don't have root access, the "fat" archive is the next best choice.

* Operate on an older platform
* Need a package that hasn’t been released into the latest distribution
* Be supported for a longer period of time (the latest release isn’t necessarily supported the longest)
macOS and Windows users who choose to install from binary packages only have the "fat" archive option
(Debian packages are exclusive to Ubuntu/Debian).

General users with no special considerations should use the most recent release available.
**Building from source** is meant for developers looking to alter or explicitly omit parts of ROS 2's base.
It is also recommended for platforms that don't support binaries.
Building from source also gives you the option to install the absolute latest version of ROS 2.

Contributing to ROS 2 core?
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
60 changes: 0 additions & 60 deletions source/Installation/Summary.rst

This file was deleted.

2 changes: 1 addition & 1 deletion source/Releases/Release-Foxy-Fitzroy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For more information about RMW implementations, compiler / interpreter versions,
Installation
------------

`Install Foxy Fitzroy <../Installation/Summary>`
`Install Foxy Fitzroy <../Installation>`

New features in this ROS 2 release
----------------------------------
Expand Down