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

Dev FAQ

Browse Source
This commit is contained in:
kn0wmad
2021-12-07 20:30:40 -07:00
committed by Lucy Cifferello
parent ff5871dd9a
commit 77439ce07f
4 changed files with 39 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
source/dev-docs/dev-faq/faq-contributing.rst
View File

@@ -4,20 +4,22 @@
Contributing
************
We ❤️ contributions!
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.
Do I need to be a professional developer or have coding experience to contribute?
---------------------------------------------------------------------------------
Absolutely not! Contributions can be as simple as finding a typo in our docs, making a suggestion on GitHub, creating educational or promotional content, and the list goes on! Everyone that wants to contribute can do so in some unique way. Please don't hesitate to ***CONTACT LINK*** us for ideas if you're not sure where to begin.
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.
Expound the following into FAQs move to other dev-faq section if necessary:
---------------------------------------------------------------------------
- Not requred to be a developer? * - Programming experience is not required** Sysadmin exp would be helpful
- Release notes need to be in quotations? As it is a string? (they aren’t by default) – this is a yaml thing and SOMETIMES they are required and SOMETIMES NOT
- Ports in manifest – can leave as default (80), as it is a docker container?? - Sure
- Type definitions – is this just for dependencies? Can a blurb be added here for extra clarity?
- Alerts in LND example are not wrapped in quotes, same with CUPS release notes – yaml thing
- If already dockerized – use most of the existing, presumably?
- Config spec – Admin pass?
- Makefile
- Not required (required for make)
- config yamls CAN be empty, if there is nothing to config
- Not required, but simplifies dev process

26
source/dev-docs/dev-faq/faq-service-packaging.rst
View File

@@ -4,8 +4,28 @@
Service Packaging FAQ
*********************
Do I need programming experience to package a service for EmbassyOS?
--------------------------------------------------------------------
It would be helpful, but is not a pre-requisite. Linux, dev-ops, and/or systems administration experience would all be helpful as well. Keep in mind that everyone has to start somewhere, and perhaps your journey to development begins with packaging a service for EOS!
What considerations are there when choosing a service for packaging?
--------------------------------------------------------------------
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>`
Recommendations that may ease the process:
#. A service that has already been 'dockerized' (has a **working** ``Dockerfile``)
#. A service written in a language you are familiar with
#. A service with a strong community
What if I don't need a Config in my service?
--------------------------------------------
Config files can be empty(``{}``), if you do not require config.
How can my service access the data directory of another service?
----------------------------------------------------------------
1. Provider service needs to expose datadir to other services on embassy
2. 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
#. 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

8
source/dev-docs/packaging-example.rst
View File

@@ -1,10 +1,10 @@
.. _packaging-example:
*********************************
EmbassyOS Service Packaging Guide
*********************************
***********************
Service Packaging Guide
***********************
A rough walkthrough of how to package a service using our example "Hello World" wrapper.
A rough walkthrough of how to package a service using our example `hello-world-wrapper <https://github.com/Start9Labs/hello-world-wrapper>`_.
Welcome! The following guide will provide the prerequisites, introduce a brief overview of the packaging process, use an example demonstrating how to package a service, and finally describe the submission process. This essentially describes how you can take an existing app (or one you have written yourself), and wrap it up such that it can be added to an EmbassyOS Marketplace!

8
source/dev-docs/service-packaging/index.rst
View File

@@ -1,10 +1,10 @@
*****************
Service Packaging
*****************
*******************************
Service Packaging Specification
*******************************
Welcome! If you are here, you are interested in becoming part of the mission to change the future of personal computing. This guide will take you through the process of packaging a service for EmbassyOS, a novel, self-hosted, sovereign computing platform.
A service in this context is any open source project that has been bundled into the appropriate format to run on EmbassyOS. By configuring and packaging a project according to this guide, it can be installed on EmbassyOS with no command line or technical expertise required. This opens up an entire platform for self-hosted software to run independent of third parties in a completely private and sovereign way for all individuals.
A service in this context is any open source project that has been bundled into the appropriate format to run on EmbassyOS. By configuring and packaging a project according to this guide, it can be installed on EmbassyOS with no command line or technical expertise required. This opens up an entire platform for self-hosted software to run independent of third parties in a completely private and sovereign way for all individuals.
This guide is technical, but breaks down the steps for deployment. If you have any feedback or questions concerning this guide, please don't hesitate to `reach out <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ or submit a pull request with alterations.