Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-04-01 21:13:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating references to embassy-sdk to start-sdk in dev-docs/specifications (#486)

Browse Source
This commit is contained in:
Jadi
2023-08-21 16:25:34 +03:30
committed by GitHub
parent 174d6139c4
commit 0fbc722c9f
3 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
site/source/developer-docs/specification/checklist.rst
View File

@@ -5,7 +5,7 @@ Checklist
========= =========
.. contents:: .. contents::
:depth: 2 :depth: 2
:local: :local:
This guide outlines a checklist of steps to complete in order to package a service for StartOS. For a more in depth example, visit the :ref:`build your first package <service-packaging>` guide. This guide outlines a checklist of steps to complete in order to package a service for StartOS. For a more in depth example, visit the :ref:`build your first package <service-packaging>` guide.
@@ -22,8 +22,8 @@ Packaging
7. Create instructions file 7. Create instructions file
8. Create icon file 8. Create icon file
9. Add license 9. Add license
10. Package all components into s9pk using embassy-sdk 10. Package all components into s9pk using start-sdk
11. Verify package components using embassy-sdk 11. Verify package components using start-sdk
12. Create a wrapper repository on GitHub to host all package assets for review 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 13. (Optional) Add all package build steps to a Makefile for replicability

2
site/source/developer-docs/specification/makefile.rst
View File

@@ -15,7 +15,7 @@ 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 prerequisites for running the docker file - Build all prerequisites for running the docker file
- Build all dependencies - Build all dependencies
- Package assets and docker image using ``embassy-sdk pack`` - Package assets and docker image using ``start-sdk pack``
Example Example
------- -------

8
site/source/developer-docs/specification/package.rst
View File

@@ -13,7 +13,7 @@ The minimum necessary files for this bundle are:
- LICENSE - LICENSE
- icon.png - icon.png
Each new version release of a service should include the updated version of these files re-bundled into a new ``.s9pk``. . Each new version release of a service should include the updated version of these files re-bundled into a new ``.s9pk``. .
Building Building
-------- --------
@@ -22,12 +22,12 @@ To package all components into an ``.s9pk``, run the following command from the
.. code:: bash .. code:: bash
embassy-sdk pack start-sdk pack
Let's also make sure to verify the validity of the package: Let's also make sure to verify the validity of the package:
.. code:: bash .. code:: bash
embassy-sdk verify s9pk /path/to/hello-world.s9pk start-sdk verify s9pk /path/to/hello-world.s9pk
If anything goes wrong, an error message will indicate the missing component or other failure. If anything goes wrong, an error message will indicate the missing component or other failure.