From 8208812147a385e29e46f83bcb4f16bf50c06f3c Mon Sep 17 00:00:00 2001 From: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Date: Mon, 8 Feb 2021 08:57:15 -0700 Subject: [PATCH] reorganizing contribution guide --- source/_static/default.css | 6 +++++- source/contributing/embassyos.rst | 14 ++++++++++++++ source/contributing/services/docker.rst | 2 ++ source/contributing/{ => services}/index.rst | 18 +++++++++--------- source/contributing/services/overview.rst | 2 +- source/index.rst | 3 ++- source/support/contact.rst | 2 +- 7 files changed, 34 insertions(+), 13 deletions(-) create mode 100644 source/contributing/embassyos.rst rename source/contributing/{ => services}/index.rst (81%) diff --git a/source/_static/default.css b/source/_static/default.css index d78f833..24ebebf 100644 --- a/source/_static/default.css +++ b/source/_static/default.css @@ -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; } diff --git a/source/contributing/embassyos.rst b/source/contributing/embassyos.rst new file mode 100644 index 0000000..e096bb4 --- /dev/null +++ b/source/contributing/embassyos.rst @@ -0,0 +1,14 @@ +.. _embassyos_contribute: + +********* +EmbassyOS +********* + +We ❤️ contributions! + +Please follow the guide `here `_ and reach out to the `community dev `_ channel on Matrix with any questions. + +.. role:: raw-html(raw) + :format: html + +:raw-html:`
` \ No newline at end of file diff --git a/source/contributing/services/docker.rst b/source/contributing/services/docker.rst index 2516f47..9cfc571 100644 --- a/source/contributing/services/docker.rst +++ b/source/contributing/services/docker.rst @@ -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`` diff --git a/source/contributing/index.rst b/source/contributing/services/index.rst similarity index 81% rename from source/contributing/index.rst rename to source/contributing/services/index.rst index 7168a4c..ea225ba 100644 --- a/source/contributing/index.rst +++ b/source/contributing/services/index.rst @@ -1,4 +1,4 @@ -.. _service_sdk: +.. _service_pacakge: *********************** Service Packaging Guide @@ -13,14 +13,14 @@ For reference, the `Hello world - Wrapper - Docker - Makefile - Manifest - Config - Properties - Docs + Overview + Wrapper + Docker + Makefile + Manifest + Config + Properties + Docs Submission process ------------------ diff --git a/source/contributing/services/overview.rst b/source/contributing/services/overview.rst index 6babbd2..cd476cd 100644 --- a/source/contributing/services/overview.rst +++ b/source/contributing/services/overview.rst @@ -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/``. -.. 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 `. diff --git a/source/index.rst b/source/index.rst index 7d1a096..0d1a234 100644 --- a/source/index.rst +++ b/source/index.rst @@ -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 diff --git a/source/support/contact.rst b/source/support/contact.rst index 78cc646..0d7fa05 100644 --- a/source/support/contact.rst +++ b/source/support/contact.rst @@ -6,6 +6,6 @@ Contact `Telegram `_ - best for one off questions or back and forth direct messages -`Matrix `_ - we will eventually be migrating our community channel off telegram and onto this self hosted communication platform +`Matrix `_ - we will eventually be migrating our community channel off telegram and onto this self hosted communication platform `support@start9labs.com `_ - best for more involved questions \ No newline at end of file