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

@@ -1,8 +1,8 @@
.. _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.

View File

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

View File

@@ -9,25 +9,25 @@ This guide outlines a checklist of steps to complete in order to package a servi
Packaging
---------
1. Create or select project
2. Build project
3. Cross compile for armv8/aarch64 if necessary
4. Create Dockerfile and docker entrypoint file
5. Add build steps, compiled executables, assets, etc in Dockerfile and specify run command in docker entrypoint, handling signal exiting if the service does not already do this gracefully
6. Create Manifest file
7. Create instructions file
8. Create icon file
9. Add license
10. Package all components into s9pk using embassy-sdk
11. Verify package components using embassy-sdk
12. Create a wrapper repository on GitHub to host all package assets for review
13. (Optional) Add all package build steps to a Makefile for replicability
1. Create or select project
2. Build project
3. Cross compile for armv8/aarch64 if necessary
4. Create Dockerfile and docker entrypoint file
5. Add build steps, compiled executables, assets, etc in Dockerfile and specify run command in docker entrypoint, handling signal exiting if the service does not already do this gracefully
6. Create Manifest file
7. Create instructions file
8. Create icon file
9. Add license
10. Package all components into s9pk using embassy-sdk
11. Verify package components using embassy-sdk
12. Create a wrapper repository on GitHub to host all package assets for review
13. (Optional) Add all package build steps to a Makefile for replicability
Testing:
--------
1. Sideload ``<package-id>.s9pk`` onto an Embassy
2. Install package using embassy-cli
3. Start package using embassy-cli, or in the UI
4. Check logs to see if errors
5. Ensure service is reachable/launchable
1. Sideload ``<package-id>.s9pk`` onto an Embassy
2. Install package using embassy-cli
3. Start package using embassy-cli, or in the UI
4. Check logs to see if errors
5. Ensure service is reachable/launchable

View File

@@ -49,10 +49,10 @@ embassy-sdk pack
This command takes the necessary package components and assembles them into the `s9pk` file format needed to install a service on EmbassyOS. It expects the following files to exist:
- Manifest
- Instructions
- License
- Icon
- Manifest
- Instructions
- License
- Icon
If this command fails, the error response will indicate which component is missing.
@@ -61,11 +61,11 @@ embassy-sdk verify
This command verifies aspects about the components assembled into the `s9pk`, such as:
- Ensures that all mounts are real volumes in the manifest
- Ensures all cert volumes point to real interfaces in the manifest
- Ensures all actions refer to real images in the manifest
- Ensures all images are tagged correctly in the manifest
- Ensures the icon is less than 100KB
- Ensures that all mounts are real volumes in the manifest
- Ensures all cert volumes point to real interfaces in the manifest
- Ensures all actions refer to real images in the manifest
- Ensures all images are tagged correctly in the manifest
- Ensures the icon is less than 100KB
It should be run _after_ `embassy-sdk pack` in order to verify the validity of each component.
@@ -83,12 +83,12 @@ This command contains several utilities for reading components once packaged int
It contains the following subcommands, and requires the path to the `<pacakge-id>.s9pk` file as the last argument:
- docker-images
- hash
- icon
- instructions
- license
- manifest
- docker-images
- hash
- icon
- instructions
- license
- manifest
For example: