Dev FAQ initial commit

This commit is contained in:
kn0wmad
2021-09-03 08:59:20 -06:00
parent 04e7a4d177
commit d1e37a4550
9 changed files with 47 additions and 0 deletions

View File

@@ -1,3 +1,5 @@
.. _030_faq:
***********************
EmbassyOS Version 0.3.0
***********************

View File

@@ -1,3 +1,5 @@
.. _bitcoin_faq:
*****************************
Bitcoin and Lightning Network
*****************************

View File

@@ -0,0 +1,32 @@
.. _dev_faq:
**************************
Contributing & Development
**************************
What versions does this FAQ concern?
------------------------------------
This FAQ concerns only EmbassyOS version 0.3.0 and above. For v0.2.x documentation, please see our :ref:`Service Packaging Guide <service_package_overview>`.
What language does the application I want to package need to be written in?
---------------------------------------------------------------------------
The application can be written in any language, so you may prefer to select an application in a language you are comfortable with (or write your own application). It is only important that the packaging specifications be followed.
What considerations go into selecting an application to package?
----------------------------------------------------------------
With sufficient effot, most any software with the ability to be self-hosted could make its way onto EmbassyOS. That being said, the following features will make service packaging much easier:
- Already built with self-hosting in mind
- Active development
- Built-in tor support
- Already 'dockerized'
Which possible formats can I use to write the :code:`manifest`, :code:`config_spec`, and :code:`config_rules` files?
-------------------------------------------------------------------------------------------------------------------
JSON, TOML, or YAML are valid options.
I'm getting errors on the `embassy-sdk pack` step. What's going on?
--------------------------------------------------------------------
There is something either missing or incorrect in regard to one of the :code:`manifest`, :code:`configs`, :code:`instructions`, or :code:`icon` files.

View File

@@ -1,3 +1,5 @@
.. _embassy_faq:
*****************************
Embassy (Device, OS, and DIY)
*****************************

View File

@@ -1,3 +1,5 @@
.. _general_faq:
*******
General
*******

View File

@@ -14,3 +14,4 @@ A collection of common questions and concerns from our community.
services-faq
bitcoin-faq
030-faq
dev-faq

View File

@@ -1,3 +1,5 @@
.. _services_faq:
********
Services
********

View File

@@ -1,3 +1,5 @@
.. _setup_faq:
*************************
Setup and Troubleshooting
*************************

View File

@@ -1,3 +1,5 @@
.. _usage_faq:
***********
Basic Usage
***********