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

update dev docs titles, spacing, properties content

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

36
site/source/developer-docs/getting-started/quick-start.rst
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