Misc edits

This commit is contained in:
kn0wmad
2022-01-04 16:47:53 -07:00
committed by Lucy Cifferello
parent 94ec70d684
commit 8d9a8894c5
7 changed files with 105 additions and 90 deletions

View File

@@ -5,7 +5,7 @@
:local:
=====================
Service Packaging FAQ - **EXPAND**
Service Packaging FAQ
=====================
Do I need programming experience to package a service for EmbassyOS?
@@ -18,11 +18,11 @@ There are several things you will want to consider. Requirements include:
#. Most importantly, pick a service you are passionate about seeing on EmbassyOS
#. Make sure it is :ref:`Open Source <open-source>`
#. A service that incorporates a 'self-hosting' option, or is capable of being self-hosted
Recommendations that may ease the process:
#. A service that has already been 'dockerized' (has a **working** ``Dockerfile``)
#. A service that incorporates a 'self-hosting' option
#. A service written in a language you are familiar with
#. A service with a strong community
@@ -30,9 +30,13 @@ You can check this expansive list if you are in search of ideas: `Awesome Self-H
What if I don't need a Config in my service?
--------------------------------------------
Config files can be empty(``{}``), if you do not require config.
Config files can be empty( ``{}`` ), if you do not require config.
How can my service access the data directory of another service?
----------------------------------------------------------------
#. Provider service needs to expose datadir to other services on embassy
#. Consumer services needs to list the provider service as a dependency AND set a particular config value, stating that it wants data from that particular service
The guide says that a Makefile is optional, why is this?
--------------------------------------------------------
The ``Makefile`` simplifies the development process by putting all your build steps into one place so that you can simply use the ``make`` to build with. A ``Makefile`` is not required however, and you may instead choose to use something like ``nix``, ``bash``, ``perl``, ``python``, or ``ruby`` for your build orchestration.