From d1e37a4550aea8db1379de79eadaa9f9f8581091 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Fri, 3 Sep 2021 08:59:20 -0600 Subject: [PATCH] Dev FAQ initial commit --- source/support/FAQ/030-faq.rst | 2 ++ source/support/FAQ/bitcoin-faq.rst | 2 ++ source/support/FAQ/dev-faq.rst | 32 +++++++++++++++++++++++++++++ source/support/FAQ/embassy-faq.rst | 2 ++ source/support/FAQ/general-faq.rst | 2 ++ source/support/FAQ/index.rst | 1 + source/support/FAQ/services-faq.rst | 2 ++ source/support/FAQ/setup-faq.rst | 2 ++ source/support/FAQ/usage-faq.rst | 2 ++ 9 files changed, 47 insertions(+) create mode 100644 source/support/FAQ/dev-faq.rst diff --git a/source/support/FAQ/030-faq.rst b/source/support/FAQ/030-faq.rst index e7db518..ef1b90e 100644 --- a/source/support/FAQ/030-faq.rst +++ b/source/support/FAQ/030-faq.rst @@ -1,3 +1,5 @@ +.. _030_faq: + *********************** EmbassyOS Version 0.3.0 *********************** diff --git a/source/support/FAQ/bitcoin-faq.rst b/source/support/FAQ/bitcoin-faq.rst index e2142df..81969eb 100644 --- a/source/support/FAQ/bitcoin-faq.rst +++ b/source/support/FAQ/bitcoin-faq.rst @@ -1,3 +1,5 @@ +.. _bitcoin_faq: + ***************************** Bitcoin and Lightning Network ***************************** diff --git a/source/support/FAQ/dev-faq.rst b/source/support/FAQ/dev-faq.rst new file mode 100644 index 0000000..2e12113 --- /dev/null +++ b/source/support/FAQ/dev-faq.rst @@ -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 `. + +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. + + diff --git a/source/support/FAQ/embassy-faq.rst b/source/support/FAQ/embassy-faq.rst index b529a03..9d12797 100644 --- a/source/support/FAQ/embassy-faq.rst +++ b/source/support/FAQ/embassy-faq.rst @@ -1,3 +1,5 @@ +.. _embassy_faq: + ***************************** Embassy (Device, OS, and DIY) ***************************** diff --git a/source/support/FAQ/general-faq.rst b/source/support/FAQ/general-faq.rst index 699f2dc..dce625d 100644 --- a/source/support/FAQ/general-faq.rst +++ b/source/support/FAQ/general-faq.rst @@ -1,3 +1,5 @@ +.. _general_faq: + ******* General ******* diff --git a/source/support/FAQ/index.rst b/source/support/FAQ/index.rst index 32d4c0f..2f3058b 100644 --- a/source/support/FAQ/index.rst +++ b/source/support/FAQ/index.rst @@ -14,3 +14,4 @@ A collection of common questions and concerns from our community. services-faq bitcoin-faq 030-faq + dev-faq diff --git a/source/support/FAQ/services-faq.rst b/source/support/FAQ/services-faq.rst index f3b3457..bd071d0 100644 --- a/source/support/FAQ/services-faq.rst +++ b/source/support/FAQ/services-faq.rst @@ -1,3 +1,5 @@ +.. _services_faq: + ******** Services ******** diff --git a/source/support/FAQ/setup-faq.rst b/source/support/FAQ/setup-faq.rst index a7b847f..889b0a5 100644 --- a/source/support/FAQ/setup-faq.rst +++ b/source/support/FAQ/setup-faq.rst @@ -1,3 +1,5 @@ +.. _setup_faq: + ************************* Setup and Troubleshooting ************************* diff --git a/source/support/FAQ/usage-faq.rst b/source/support/FAQ/usage-faq.rst index 00a3b4a..d2d0749 100644 --- a/source/support/FAQ/usage-faq.rst +++ b/source/support/FAQ/usage-faq.rst @@ -1,3 +1,5 @@ +.. _usage_faq: + *********** Basic Usage ***********