update dev docs titles, spacing, properties content

This commit is contained in:
Lucy Cifferello
2022-02-24 14:38:46 -07:00
parent 5583f26384
commit d9088fab5b
15 changed files with 99 additions and 90 deletions

View File

@@ -36,7 +36,7 @@ This section included advanced commands for working with packages in EmbassyOS.
.. This is for the side navigation display .. This is for the side navigation display
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
:hidden: :hidden:
dev-tools/index dev-tools/index

View File

@@ -1,8 +1,8 @@
.. _packaging-setup: .. _packaging-framework:
========================== ==================
Step 1 - Context and Setup Step 1 - Framework
========================== ==================
What we'll build What we'll build
---------------- ----------------

View File

@@ -1,8 +1,8 @@
.. _packaging-compile-raspi: .. _packaging-compile-raspi:
=========================== =======================
Step 3 - Build for Hardware Step 3 - Hardware Build
=========================== =======================
EmbassyOS is run on the arm-v8 architecture, specifically the aarch64 state, for the RaspberryPi. EmbassyOS is run on the arm-v8 architecture, specifically the aarch64 state, for the RaspberryPi.

View File

@@ -1,8 +1,8 @@
.. _packaging-docker-build: .. _packaging-docker-build:
========================== =====================
Step 4 - Build with Docker Step 4 - Docker Build
========================== =====================
Now that we have our code properly built/compiled, we can create a Dockerfile. This file defines how to build the Docker image for the service by declaring the environment, building stages, and copying any binaries or assets needed to run the service to the Docker image filesystem. Now that we have our code properly built/compiled, we can create a Dockerfile. This file defines how to build the Docker image for the service by declaring the environment, building stages, and copying any binaries or assets needed to run the service to the Docker image filesystem.

View File

@@ -1,8 +1,8 @@
.. _packaging-create-s9pk: .. _packaging-create-s9pk:
========================== =======================
Step 7 - Package into s9pk Step 7 - Format Package
========================== =======================
We now have all of the necessary components to package the service into the format needed for the OS. This format is a custom filetype with an extension of ``.s9pk``, short for Start9 Package. We now have all of the necessary components to package the service into the format needed for the OS. This format is a custom filetype with an extension of ``.s9pk``, short for Start9 Package.

View File

@@ -1,8 +1,8 @@
.. _packaging-create-wrapper: .. _packaging-create-wrapper:
============================ =======================
Step 9 - Create Wrapper Repo Step 9 - Create Wrapper
============================ =======================
In order for the Start9 team to review your package for submission to the Start9 Marketplace, we ask that you create a wrapper repository for the project and its components. This repo should contain everything you need to build the service. In order for the Start9 team to review your package for submission to the Start9 Marketplace, we ask that you create a wrapper repository for the project and its components. This repo should contain everything you need to build the service.

View File

@@ -19,10 +19,10 @@ Now that we have a process for iterating on producing a valid package for Embass
2. On an Embassy device, enter the ssh pubkey into your SSH settings: 2. On an Embassy device, enter the ssh pubkey into your SSH settings:
#. Click on Embassy in the menu 1. Click on Embassy in the menu
#. Click on SSH under SETTINGS 2. Click on SSH under SETTINGS
#. Click on + Add new key 3. Click on + Add new key
#. Paste pubkey from clipboard 4. Paste pubkey from clipboard
3. Copy the ``hello-world.s9pk`` to the Embassy device: 3. Copy the ``hello-world.s9pk`` to the Embassy device:

View File

@@ -1,8 +1,8 @@
.. _environment-setup: .. _environment-setup:
=========================== =================
Packaging Environment Setup Environment Setup
=========================== =================
To get started packaging a service for EmbassyOS, some basic knowledge of software development is required. Don't worry if you are inexperienced, we will provide enough context to get you started, and you can always reach out with questions. To get started packaging a service for EmbassyOS, some basic knowledge of software development is required. Don't worry if you are inexperienced, we will provide enough context to get you started, and you can always reach out with questions.

View File

@@ -37,7 +37,7 @@ Getting Started Overview
:class: large-4 :class: large-4
:anchor: Begin :anchor: Begin
Quickly get started with concise packaging steps Quickly get started with concise steps
.. topic-box:: .. topic-box::
:title: SDK :title: SDK

View File

@@ -16,9 +16,18 @@ Due to the fact that config variables are only available when the service is run
.. code:: typescript .. code:: typescript
:caption: Properties Type :caption: Properties Type
interface Properties {
version: Enum<v1 | v2>,
data: Data,
}
interface Data {
# The key here is an string that describes the property appropriately
<String> : PropertiesString | PropertiesObject
}
interface PropertiesString { interface PropertiesString {
type: 'string' type: 'string'
name: string name: string
@@ -38,7 +47,7 @@ Due to the fact that config variables are only available when the service is run
Example Example
------- -------
A good example of the configurator producing the ``stats.yaml`` file can be found `here <https://github.com/Start9Labs/lnd-wrapper/blob/master/configurator/src/main.rs>`_. An example ``stats.yaml`` file generation can be found `here <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/docker_entrypoint.sh#L15-L30>`__.
.. role:: raw-html(raw) .. role:: raw-html(raw)
:format: html :format: html

View File

@@ -113,7 +113,7 @@
.. This is for the side navigation display .. This is for the side navigation display
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 4
:hidden: :hidden:
Purchase <https://store.start9.com> Purchase <https://store.start9.com>