Skip to content
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
11 changes: 2 additions & 9 deletions source/Getting-Started.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,8 @@
Getting Started
===============

To get started with Space ROS development, you can either download a pre-built Docker image from Docker Hub, or build the Docker image yourself.
The following pages describe each of these scenarios.
To get started with Space ROS development, you can either download a pre-built Docker image from Docker Hub, or build the Docker image yourself using the instructions in the :doc:`First Time Building tutorial <Tutorials/First-Time-Building>`.

.. toctree::
:titlesonly:
:maxdepth: 2

Getting-Started/Docker-Images
Getting-Started/Building-From-Source
Pre-built Docker images are available from the `OSRF Space ROS page <https://hub.docker.com/r/osrf/space-ros>`_ on Docker Hub.

Once you have a Docker image, you may want to review the :doc:`Demos <Demos>`, :doc:`Tutorials <Tutorials>`, and :doc:`How-To Guides <How-To-Guides>` to learn more about various Space ROS topics.

6 changes: 0 additions & 6 deletions source/Getting-Started/Building-From-Source.rst

This file was deleted.

9 changes: 0 additions & 9 deletions source/Getting-Started/Docker-Images.rst

This file was deleted.

2 changes: 0 additions & 2 deletions source/How-To-Guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@ They contain succinct steps to help you accomplish important tasks quickly.
.. toctree::
:maxdepth: 1

How-To-Guides/Use-Custom-Allocator
How-To-Guides/Reproducing-CI-Results
How-To-Guides/Use-Cobra
How-To-Guides/MC-DC-Testing-Tool
How-To-Guides/Use-VSCode-With-Docker
How-To-Guides/Use-The-Dashboard
How-To-Guides/Use-Simulation-Assets
How-To-Guides/Releasing-Space-ROS
8 changes: 0 additions & 8 deletions source/How-To-Guides/Use-Custom-Allocator.rst

This file was deleted.

7 changes: 0 additions & 7 deletions source/How-To-Guides/Use-Simulation-Assets.rst

This file was deleted.

2 changes: 0 additions & 2 deletions source/Introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ The following sections describe the motivation for Space ROS, how Space ROS is d

Introduction/About-Space-ROS
Introduction/How-Space-ROS-Differs
Introduction/Dev-And-Release-Model

.. image:: /images/viper-lights.png
:alt: Artist's rendition of the VIPER rover on the surface of the moon

11 changes: 0 additions & 11 deletions source/Introduction/Dev-And-Release-Model.rst

This file was deleted.

2 changes: 1 addition & 1 deletion source/Related-Projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Related Projects
Space ROS makes use of several external projects that aren't part of standard ROS 2 distributions.
The first pair of tools, IKOS and Cobra, are static analysis tools that have been integrated into Space ROS using the same Python wrapper method used for other code analysis tools integrated into standard ROS 2 distributions, such as clang-tidy and cpplint.
The full set of code analysis tools are run automatically when building and running package tests ('colcon test').
The next set of tools, Doorstop and FRET, are requirements tools that are part of an :doc:`overall requirements methodology <Tutorials/Requirements-Tools-And-Processes>` used for Space ROS.
The next set of tools, Doorstop and FRET, are requirements tools used for Space ROS.
The last tool, Ogma, is a runtime verification tool that produces monitoring applications for Space ROS.

.. toctree::
Expand Down
3 changes: 0 additions & 3 deletions source/Related-Projects/Doorstop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ Why use Doorstop?
Contributors to an open source project like Space ROS are unlikely to purchase expensive requirements management tools or use heavyweight requirements processes.
Using the open source Doorstop tool to manage requirements helps to strike a balance between the need for strong processes to support certification, such as requirements traceability, and ease-of-contributing for the open source community.

To learn more about how Doorstop is used in Space ROS, please refer to this tutorial on the `Requirements Tools and Processes <../Tutorials/Requirements-Tools-And-Processes>`_ used in Space ROS.

Additional References
---------------------

Expand All @@ -25,4 +23,3 @@ Please refer to the following resources to learn more about Doorstop:
* `Doorstop documentation <https://doorstop.readthedocs.io/en/latest/>`_
* `The Doorstop github repository <https://github.com/doorstop-dev/doorstop>`_
* `Doorstop: Text-Based Requirements Management Using Version Control <https://www.researchgate.net/publication/276044183_Doorstop_Text-Based_Requirements_Management_Using_Version_Control>`_

2 changes: 0 additions & 2 deletions source/Related-Projects/FRET.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ Doorstop, along with git, is used to ensure requirements tracking and traceabili
To facilitate interoperability, FRET is able to import and export the Markdown-based requirements file format used by Doorstop.
Requirements can be stored in a git repository and operated on by either FRET or Doorstop.

To learn more about how FRET is used in Space ROS, please refer to this tutorial on the `Requirements Tools and Processes <../Tutorials/Requirements-Tools-And-Processes>`_ used in Space ROS.

Additional References
---------------------

Expand Down
4 changes: 0 additions & 4 deletions source/Tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,3 @@ The following tutorials are specific to Space ROS.
:maxdepth: 2

Tutorials/First-Time-Building
Tutorials/Eventing-And-Telemetry
Tutorials/Requirements-Tools-And-Processes
Tutorials/Back-Porting-Requirements
Tutorials/Run-On-RTEMS
6 changes: 0 additions & 6 deletions source/Tutorials/Back-Porting-Requirements.rst

This file was deleted.

6 changes: 0 additions & 6 deletions source/Tutorials/Eventing-And-Telemetry.rst

This file was deleted.

8 changes: 0 additions & 8 deletions source/Tutorials/Requirements-Tools-And-Processes.rst

This file was deleted.

8 changes: 0 additions & 8 deletions source/Tutorials/Run-On-RTEMS.rst

This file was deleted.