From 9e6c9209c1c92dac072b6ea853485e075b60e2c9 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Mon, 6 Dec 2021 13:17:20 -0700 Subject: [PATCH] Dev docs init --- source/dev-docs/dev-faq/faq-contributing.rst | 13 +++++++++++++ source/dev-docs/dev-faq/faq-service-packaging.rst | 8 +++++++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/source/dev-docs/dev-faq/faq-contributing.rst b/source/dev-docs/dev-faq/faq-contributing.rst index eccafd4..2b65ed3 100644 --- a/source/dev-docs/dev-faq/faq-contributing.rst +++ b/source/dev-docs/dev-faq/faq-contributing.rst @@ -8,3 +8,16 @@ We ❤️ contributions! Please follow the guide `here `_ and reach out to the `community dev `_ 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 \ No newline at end of file diff --git a/source/dev-docs/dev-faq/faq-service-packaging.rst b/source/dev-docs/dev-faq/faq-service-packaging.rst index bfe16f2..dc440aa 100644 --- a/source/dev-docs/dev-faq/faq-service-packaging.rst +++ b/source/dev-docs/dev-faq/faq-service-packaging.rst @@ -2,4 +2,10 @@ ********************* Service Packaging FAQ -********************* \ No newline at end of file +********************* + +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