reorganizing contribution guide

This commit is contained in:
Lucy Cifferello
2021-02-08 08:57:15 -07:00
parent 3061f1ec08
commit 8208812147
7 changed files with 34 additions and 13 deletions

View File

@@ -51,10 +51,14 @@ h1, h2 {
}
.admonition.warning .admonition-title, .admonition.note .admonition-title, .admonition.important .admonition-title {
.admonition.warning .admonition-title, .admonition.note .admonition-title {
background-color: #666;
}
.important .admonition-title {
background-color: none!important;
}
.header-style:before, h1:before, h2:before, h3:before, h4:before, h5:before, h6:before {
display: inline;
}

View File

@@ -0,0 +1,14 @@
.. _embassyos_contribute:
*********
EmbassyOS
*********
We ❤️ contributions!
Please follow the guide `here <https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md>`_ and reach out to the `community dev <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ channel on Matrix with any questions.
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`

View File

@@ -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``

View File

@@ -1,4 +1,4 @@
.. _service_sdk:
.. _service_pacakge:
***********************
Service Packaging Guide
@@ -13,14 +13,14 @@ For reference, the `Hello world <https://github.com/Start9Labs/hello-world-wrapp
.. toctree::
:maxdepth: 2
Overview <services/overview>
Wrapper <services/wrapper>
Docker <services/docker>
Makefile <services/makefile>
Manifest <services/manifest>
Config <services/config>
Properties <services/properties>
Docs <services/docs>
Overview <overview>
Wrapper <wrapper>
Docker <docker>
Makefile <makefile>
Manifest <manifest>
Config <config>
Properties <properties>
Docs <docs>
Submission process
------------------

View File

@@ -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>`.

View File

@@ -35,7 +35,8 @@ Here you will find guidance and information about the Start9 Embassy personal se
:maxdepth: 2
:caption: Contributing
contributing/index
contributing/services/index
contributing/embassyos
.. toctree::
:maxdepth: 2

View File

@@ -6,6 +6,6 @@ Contact
`Telegram <https://t.me/start9_labs>`_ - best for one off questions or back and forth direct messages
`Matrix <https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com>`_ - we will eventually be migrating our community channel off telegram and onto this self hosted communication platform
`Matrix <https://matrix.to/#/#community:matrix.start9labs.com>`_ - we will eventually be migrating our community channel off telegram and onto this self hosted communication platform
`support@start9labs.com <mailto:support@start9labs.com>`_ - best for more involved questions