Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-31 04:23:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

More typos

Browse Source
This commit is contained in:
kn0wmad
2021-02-26 15:06:16 -07:00
parent 435a72000f
commit 05bb4fdb11
3 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
source/contributing/services/config.rst
View File

@@ -17,7 +17,7 @@ The outcome of this step is two files:
:ref:`config_rules.yaml <config_rules>` :ref:`config_rules.yaml <config_rules>`
These files contain a detailed mapping of configuration options with acceptable values, defaults and relational rule-sets. These files contain a detailed mapping of configuration options with acceptable values, defaults, and relational rule-sets.
For example, if the user chooses config option A, then config option B must be between 5 and 10. This enables a simple GUI configuration experience, complete with validations and protections, for users. They do not have to worry about the consequences of a wrong value in a ``.conf`` file. For example, if the user chooses config option A, then config option B must be between 5 and 10. This enables a simple GUI configuration experience, complete with validations and protections, for users. They do not have to worry about the consequences of a wrong value in a ``.conf`` file.
@@ -84,7 +84,7 @@ The following section contains implementation specifications for the ``config_sp
:ref:`pointer <pointer>` :ref:`pointer <pointer>`
- In the examples for each value spec type below, ``Option`` means the key is optional. Otherwise, the key is required. - In the examples for each value spec type below, ``Option`` means the key is optional. Otherwise, the key is required.
- Descriptions are optional but recommended - Descriptions are optional, but recommended
- Name corresponds to the name of the config field - Name corresponds to the name of the config field
- Find a complete example :ref:`here <example_config_spec>` - Find a complete example :ref:`here <example_config_spec>`
- Change warning text displays when the value is altered - Change warning text displays when the value is altered
@@ -153,7 +153,7 @@ List
^^^^ ^^^^
The list type describes an array of values. The values must consist of the same subtype, which can be any of the ValueSpec types available in the EmbassyOS config specification. The list type describes an array of values. The values must consist of the same subtype, which can be any of the ValueSpec types available in the EmbassyOS config specification.
Lists of any type do not contain the default for each item in list. The list *itself* can be have a default. If no default is provided, ``null`` will be the assumed value. Lists of any type do not contain the default for each item in list. The list *itself* can have a default. If no default is provided, ``null`` will be the assumed value.
Range is loosely based off mathematical range syntax, with infinity replaced with ``*``: Range is loosely based off mathematical range syntax, with infinity replaced with ``*``:

2
source/contributing/services/makefile.rst
View File

@@ -15,7 +15,7 @@ An alternative to using ``make`` is to use the `nix <https://nixos.wiki/wiki/Nix
This purpose of this file is to: This purpose of this file is to:
- Read the docker container and build the project - Read the docker container and build the project
- Build all prerequisite for running the docker file - Build all prerequisites for running the docker file
- Build all dependencies - Build all dependencies
- Package ``config_rules.yaml``, ``config_spec.yaml``, ``manifest.yaml``, and ``image.tar`` into an ``.s9pk`` extension by invoking ``appmgr``. - Package ``config_rules.yaml``, ``config_spec.yaml``, ``manifest.yaml``, and ``image.tar`` into an ``.s9pk`` extension by invoking ``appmgr``.

2
source/contributing/services/overview.rst
View File

@@ -38,7 +38,7 @@ Image
Each service boils down to a Docker image. We're not going to dive into Docker specifics in this guide, since there exists tons of `resources <https://docs.docker.com/>`_ for developing with this containerization tool. Each service boils down to a Docker image. We're not going to dive into Docker specifics in this guide, since there exists tons of `resources <https://docs.docker.com/>`_ for developing with this containerization tool.
Because the service ultimately runs on a Raspberry Pi, the created Docker image should be a snapshot of a arm based linux environment. The service image is then mounted to the EmbassyOS image during installation. This path is defined in the :ref:`manifest <service_manifest>` configuration file. Because the service ultimately runs on a Raspberry Pi, the created Docker image should be a snapshot of an arm based linux environment. The service image is then mounted to the EmbassyOS image during installation. This path is defined in the :ref:`manifest <service_manifest>` configuration file.
The image is immutable, meaning that when the service is updated, the image is replaced with a completely new image containing the updated features. The image is immutable, meaning that when the service is updated, the image is replaced with a completely new image containing the updated features.