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

Updated broken or non-existent links to a few doc pages #35

Open
wants to merge 1 commit into
base: rolling
Choose a base branch
from
Open
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
4 changes: 1 addition & 3 deletions source/Demos/Canadarm.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
Canadarm Demo
=============

TODO:
Instructions for running this demo can be found `here <https://github.com/space-ros/docker/tree/main/space_robots#canadarm-demo>`_ .

Describe how to run the Canadarm demo.
This may be simply a link to the demo repo that provides the instructions.
5 changes: 1 addition & 4 deletions source/Demos/Mars-Rover.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
Mars Rover Demo
===============

TODO:

Describe how to run the Mars rover demo.
This may be simply a link to the demo repo that provides the instructions
Instructions for running this demo can be found `here <https://github.com/space-ros/docker/tree/main/space_robots#curiosity-mars-rover-demo>`_ .
34 changes: 30 additions & 4 deletions source/Getting-Started/Docker-Images.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@
The Space ROS Docker Images
===========================

TODO:
There are a few Space ROS Docker images you could use for your application, such as:

* **space-ros:** This is the base SpaceROS image.
* **moveit2:** This image uses ``space-ros`` as base image and then pulls and builds the latest MoveIt2 source code.
* **space_robots:** This image uses ``space-ros`` as base image and then installs the demonstration source code necessary to run the Canadarm and Mars Rover demos.

For a complete list of additional docker images, please refer to the `space-ros/docker repository <https://github.com/space-ros/docker/blob/main>`_ .

space-ros image
---------------

The ``space-ros`` image can be accessed in two ways:

* **Docker Hub**

You can pull the space-ros image from `DockerHub <https://hub.docker.com/r/osrf/space-ros>`_ :

.. code-block:: bash

$ docker pull osrf/space-ros

* **Build image locally**

Follow the steps in the `USAGE.md <https://github.com/space-ros/space-ros/blob/main/docs/USAGE.md>`_ file from the ``space-ros`` repository.


space-robots image
-------------------

If you want to test the robot demos, you'll need to build these images. Instructions for doing this are available in the space_robots `README <https://github.com/space-ros/docker/blob/main/space_robots/README.md>`_

Describe how to use the Space ROS docker image from Docker Hub, and any other images published to Docker Hub.

* Docker Hub
* Base image, MoveIt2, demos, etc.
2 changes: 1 addition & 1 deletion source/Introduction/How-Space-ROS-Differs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,6 @@ The Space ROS project also incorporates space-specific functionality, such as a
- `RTEMS <https://www.rtems.org/>`_ is an open source real-time operating system that supports open standard application programming interfaces such as POSIX and is used in space flight, medical, networking and many more embedded devices.
To further support flight software systems we build Space ROS for RTEMS and have a demonstration application that runs on RTEMS.
* - cFS/ROS 2 Bridge
- There is an active project, the `BRASH Integration Toolkit for ROS2 and Flight Software Interoperability <https://sbir.nasa.gov/SBIR/abstracts/20/sttr/phase2/STTR-20-2-T4.01-5037.html>`_, that promises to bridge the gap between Space ROS and legacy flight software systems.
- There is an active project, the `BRASH Integration Toolkit for ROS2 and Flight Software Interoperability <https://traclabs-brash.bitbucket.io>`_, that promises to bridge the gap between Space ROS and legacy flight software systems.
We hope to work with this project to integrate some of the core functionality into Space ROS.