Skip to content

Commit

Permalink
Minor docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
cantino committed Jul 5, 2018
1 parent 7a0d5d2 commit eda47f1
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 13 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -36,6 +36,7 @@ waf-*/
*.o
*.pyc
.project
.idea
.cproject
~*
pdebug*
Expand Down
2 changes: 1 addition & 1 deletion docs/apis/kubos-hal/i2c-hal/rust-i2c.rst
Expand Up @@ -5,4 +5,4 @@ Please refer to the |i2c-api| crate documentation for implementation details

.. |i2c-api| raw:: html

<a href="../rust-docs/rust_i2c/index.html" target="_blank">Rust I2C API</a>
<a href="../../../rust-docs/rust_i2c/index.html" target="_blank">Rust I2C API</a>
8 changes: 4 additions & 4 deletions docs/architecture-overview.rst
@@ -1,7 +1,7 @@
KubOS Architecture Overview
===========================

The KubOS system is designed to take care of every aspect of the satellite's flight software.
The KubOS system is designed to take care of every aspect of a satellite's flight software.


The KubOS Stack
Expand Down Expand Up @@ -51,7 +51,7 @@ Typical Mission Architecture

In the above diagram, everything in blue/purple is developed by Kubos.
Everything in red would be mission code, written by the user for their specific mission and payload.
(Hardware services can fall into the user category if they are not integrated into the system already)
(Hardware services can fall into the user category if they are not integrated into the system already.)

Gateway
~~~~~~~
Expand Down Expand Up @@ -140,8 +140,8 @@ Nominal Operations
In day-to-day operations, the space/ground link will most commonly be used for a few different purposes:

- Executing :doc:`mission applications <what-is-a-mission-application>` on-demand. For instance, triggering a mission application which orients an imaging device to the requested coordinates and takes a picture.
- Automatically sending and receiving health and status information (health and status beacon)
- Querying the :doc:`telemetry database <services/telemetry-db>` for specific hardware status information
- Automatically sending and receiving health and status information (health and status beacon).
- Querying the :doc:`telemetry database <services/telemetry-db>` for specific hardware status information.
- Downloading payload data files through the :doc:`file transfer service <services/file>`.

These are just examples of nominal communication.
Expand Down
5 changes: 3 additions & 2 deletions docs/installation-docs/sdk-installing.rst
Expand Up @@ -9,7 +9,7 @@ to build and run a Kubos project on a target device:

- Kubos source modules - The individual components of the APIs, services,
and mission applications
- Kubos CLI - The command-line tool used to create, configure, build
- Kubos CLI - The command-line tool used to create, configure, build,
and debug Kubos projects
- Vagrant box - A command-line based VM that contains a "ready to run"
Kubos development environment
Expand All @@ -27,7 +27,8 @@ process so you can work on your project rather than setting up tooling.
`Vagrant <https://www.vagrantup.com/>`__ is a command-line based
tool that abstracts the virtualization provider into a simple-to-use
interface. Vagrant supports a variety of providers (VirtualBox, VmWare,
Parallels, etc.) but right now the Kubos SDK only supports VirtualBox.
Parallels, etc.) but right now the Kubos SDK only supports VirtualBox, a
free cross-platform virtualization provider.

Prerequisites
-------------
Expand Down
2 changes: 1 addition & 1 deletion docs/os-docs/index.rst
Expand Up @@ -3,7 +3,7 @@ Kubos Linux

Kubos Linux is a custom Linux distribution designed with embedded devices in mind.

It focuses on including only drivers that are useful for space applications (ex.
It focuses on including only drivers that are useful for space applications (eg.
I2C and SPI, rather than display drivers) and multi-layer system validation and
recovery logic.

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk-docs/index.rst
Expand Up @@ -6,7 +6,7 @@ to build Kubos projects:

- Vagrant box - The VM that contains the "ready to run" Kubos development
environment
- Kubos CLI - The command-line tool used to create, configure, build
- Kubos CLI - The command-line tool used to create, configure, build,
and debug Kubos projects
- Kubos source modules - the underlying libraries on which Kubos projects
are built
Expand Down
2 changes: 1 addition & 1 deletion docs/services/graphql.rst
Expand Up @@ -24,7 +24,7 @@ Using a human readable query language makes it obvious exactly what the satellit
Why GraphQL?
------------

GraphQL gives callers more control over how they fetch data. Where REST exposes the business domain as URL-addressable resources that clients fetch as needed, **GraphQL models the domain as graph of fields** (sometimes with arguments) that may be fetched in a single query.
GraphQL gives callers more control over how they fetch data. Where REST exposes the business domain as URL-addressable resources that clients fetch as needed, **GraphQL models the domain as a graph of fields** (sometimes with arguments) that may be fetched in a single query.

For example, say a mission application needs to quickly get the current status of a single power port on a module to check if a payload is powered. For a ReST endpoint, a separate GET would be required to be available with just that single telemetry item. Now say there are 15 different power ports, and those assignments can change depending on the payload configuration.

Expand Down
4 changes: 2 additions & 2 deletions docs/services/payload-services.rst
Expand Up @@ -5,7 +5,7 @@ Payload services are essentially hardware services which have been custom design
for mission payload hardware. They share the same architecture as the hardware
services, exposing low-level device APIs through a GraphQL interface.

The `examples folder of the Kubos repo <https://github.com/kubos/kubos>`__ includes
The `examples folder of the Kubos repo <https://github.com/kubos/kubos/tree/master/examples>`__ includes
two example payload services: one written in `Python <https://github.com/kubos/kubos/tree/master/examples/python-service>`_,
and one written in `Rust <https://github.com/kubos/kubos/tree/master/examples/rust-service>`__.

Expand Down Expand Up @@ -191,7 +191,7 @@ Otherwise, you will need to run ``pip install -r requirements.txt``.
Once the dependencies are in place, you can run ``python service.py config.yml`` and the example service should begin.
You will know that it is running if the command line output says ``* Running on http://0.0.0.1:5000/ (Press CTRL+C to quit)``.
You can now point a web browser to http://127.0.0.1:5000/graphiql to access a `graphical GraphQL interface <https://github.com/graphql/graphiql>`_.
Here you can run quries and mutations against the GraphQL endpoints and see the results.
Here you can run queries and mutations against the GraphQL endpoints and see the results.

.. note::

Expand Down
2 changes: 1 addition & 1 deletion docs/what-is-a-mission-application.rst
@@ -1,7 +1,7 @@
What is a Mission Application?
==============================

Mission applications include anything that makes decisions or governs autonomy on the satellite, as well an any other applications designed to address mission-specific concerns.
Mission applications include anything that makes decisions or governs autonomy on the satellite, as well as any other applications designed to address mission-specific concerns.

Applications can be used to accomplish anything on the system and are only limited by the computational or hardware capabilities of the spacecraft.

Expand Down

0 comments on commit eda47f1

Please sign in to comment.