From eda47f13592864f318756261826f1566acf1efc5 Mon Sep 17 00:00:00 2001 From: Andrew Cantino Date: Thu, 5 Jul 2018 16:11:40 -0700 Subject: [PATCH] Minor docs fixes --- .gitignore | 1 + docs/apis/kubos-hal/i2c-hal/rust-i2c.rst | 2 +- docs/architecture-overview.rst | 8 ++++---- docs/installation-docs/sdk-installing.rst | 5 +++-- docs/os-docs/index.rst | 2 +- docs/sdk-docs/index.rst | 2 +- docs/services/graphql.rst | 2 +- docs/services/payload-services.rst | 4 ++-- docs/what-is-a-mission-application.rst | 2 +- 9 files changed, 15 insertions(+), 13 deletions(-) diff --git a/.gitignore b/.gitignore index d04c3338a..0a71bdd94 100644 --- a/.gitignore +++ b/.gitignore @@ -36,6 +36,7 @@ waf-*/ *.o *.pyc .project +.idea .cproject ~* pdebug* diff --git a/docs/apis/kubos-hal/i2c-hal/rust-i2c.rst b/docs/apis/kubos-hal/i2c-hal/rust-i2c.rst index acb31e288..8d1038c5f 100644 --- a/docs/apis/kubos-hal/i2c-hal/rust-i2c.rst +++ b/docs/apis/kubos-hal/i2c-hal/rust-i2c.rst @@ -5,4 +5,4 @@ Please refer to the |i2c-api| crate documentation for implementation details .. |i2c-api| raw:: html - Rust I2C API + Rust I2C API diff --git a/docs/architecture-overview.rst b/docs/architecture-overview.rst index 2c661b624..4639d599d 100644 --- a/docs/architecture-overview.rst +++ b/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 @@ -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 ~~~~~~~ @@ -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 ` 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 ` for specific hardware status information +- Automatically sending and receiving health and status information (health and status beacon). +- Querying the :doc:`telemetry database ` for specific hardware status information. - Downloading payload data files through the :doc:`file transfer service `. These are just examples of nominal communication. diff --git a/docs/installation-docs/sdk-installing.rst b/docs/installation-docs/sdk-installing.rst index 75511c0a5..2808d4449 100644 --- a/docs/installation-docs/sdk-installing.rst +++ b/docs/installation-docs/sdk-installing.rst @@ -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 @@ -27,7 +27,8 @@ process so you can work on your project rather than setting up tooling. `Vagrant `__ 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 ------------- diff --git a/docs/os-docs/index.rst b/docs/os-docs/index.rst index 3bb2d8c65..b5488fb48 100644 --- a/docs/os-docs/index.rst +++ b/docs/os-docs/index.rst @@ -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. diff --git a/docs/sdk-docs/index.rst b/docs/sdk-docs/index.rst index 4d42ca9fc..bb2f39b26 100644 --- a/docs/sdk-docs/index.rst +++ b/docs/sdk-docs/index.rst @@ -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 diff --git a/docs/services/graphql.rst b/docs/services/graphql.rst index 9a20c9803..8eb5971e1 100644 --- a/docs/services/graphql.rst +++ b/docs/services/graphql.rst @@ -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. diff --git a/docs/services/payload-services.rst b/docs/services/payload-services.rst index 92454e127..bde5ddff2 100644 --- a/docs/services/payload-services.rst +++ b/docs/services/payload-services.rst @@ -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 `__ includes +The `examples folder of the Kubos repo `__ includes two example payload services: one written in `Python `_, and one written in `Rust `__. @@ -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 `_. -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:: diff --git a/docs/what-is-a-mission-application.rst b/docs/what-is-a-mission-application.rst index 8724e9f9d..be13cb1b1 100644 --- a/docs/what-is-a-mission-application.rst +++ b/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.