mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-01 04:53:41 +00:00
reorganizing contribution guide
This commit is contained in:
@@ -15,7 +15,9 @@ Since the build requires specific arm runtime environments, these base images ca
|
||||
For instance:
|
||||
|
||||
``FROM alpine:3.12``
|
||||
|
||||
``FROM arm32v7/alpine``
|
||||
|
||||
``arm32v7/golang:alpine``
|
||||
|
||||
|
||||
|
||||
33
source/contributing/services/index.rst
Normal file
33
source/contributing/services/index.rst
Normal file
@@ -0,0 +1,33 @@
|
||||
.. _service_pacakge:
|
||||
|
||||
***********************
|
||||
Service Packaging Guide
|
||||
***********************
|
||||
|
||||
This technical guide covers the necessary steps to package up a service for deployment to the EmbassyOS platform. To start, you will need to acquire :ref:`EmbassyOS <purchasing>` for testing the packaged service.
|
||||
|
||||
While you are waiting to assemble a device, you can begin the process of building your project in the format necessary to run on the Embassy. The sections below outline these steps in detail.
|
||||
|
||||
For reference, the `Hello world <https://github.com/Start9Labs/hello-world-wrapper>`_ repository should be used as an example. A project template can be cloned using the "Use this template" button in GitHub.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
Overview <overview>
|
||||
Wrapper <wrapper>
|
||||
Docker <docker>
|
||||
Makefile <makefile>
|
||||
Manifest <manifest>
|
||||
Config <config>
|
||||
Properties <properties>
|
||||
Docs <docs>
|
||||
|
||||
Submission process
|
||||
------------------
|
||||
|
||||
When you have built and tested your project for EmbassyOS, please send us a submission with the project repository to ``dev@start9labs.com``. Reach out with questions in the Matrix community `dev channel <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_.
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
:format: html
|
||||
|
||||
:raw-html:`<br />`
|
||||
@@ -10,7 +10,7 @@ Each service is an image. An image is a snapshot of a linux environment in which
|
||||
|
||||
The volume directory (for seeding data into the volume) is typically: ``/root/volumes/<serviceId>``.
|
||||
|
||||
.. important::
|
||||
.. warning::
|
||||
Any files that are in the image at the volume path will be overwritten when a backup restore occurs.
|
||||
|
||||
A service is mounted to the EmbassyOS image. Each service application gets a volume allocated to it by EmbassyOS. Within the Docker container that encompasses the service image, a path is specified as to where it should mount on EmbassyOS. This path is specified in the :ref:`manifest <service_manifest>`.
|
||||
|
||||
Reference in New Issue
Block a user