diff --git a/source/contributing/services/docker.rst b/source/contributing/services/docker.rst index cf7330a..918436a 100644 --- a/source/contributing/services/docker.rst +++ b/source/contributing/services/docker.rst @@ -32,8 +32,7 @@ It consists of a bash script that completes any environment setup (eg. creating Example ======= -See an example `here `_. - +The `LND wrapper `_ features a well defined Dockerfile, for example. .. role:: raw-html(raw) :format: html diff --git a/source/contributing/services/docs.rst b/source/contributing/services/docs.rst index 58d14dc..6f8e7de 100644 --- a/source/contributing/services/docs.rst +++ b/source/contributing/services/docs.rst @@ -12,6 +12,9 @@ If an ``instructions.md`` file is included, this markdown formatted file will be :width: 80% :alt: Bitcoin Instructions +Example +======= + The `bitcoind wrapper `_ demonstrates a good use of instructions and external integrations. .. role:: raw-html(raw) diff --git a/source/contributing/services/makefile.rst b/source/contributing/services/makefile.rst index dd6ca6e..c2df0ec 100644 --- a/source/contributing/services/makefile.rst +++ b/source/contributing/services/makefile.rst @@ -4,7 +4,9 @@ Service Makefile **************** -*This file is optional* +.. note:: + + *This file is optional* A Makefile serves as a convenience for outlining the build. This helps streamline additional developer contributions to the project. Please reference the GNU `documentation `_ for implementation details. @@ -20,7 +22,7 @@ This purpose of this file is to: Example ======= -See an example `here `_. +The `LND wrapper `_ features a well defined Makefile, for example. .. role:: raw-html(raw) :format: html diff --git a/source/contributing/services/properties.rst b/source/contributing/services/properties.rst index 2626565..7dd14fd 100644 --- a/source/contributing/services/properties.rst +++ b/source/contributing/services/properties.rst @@ -14,7 +14,10 @@ The output of this step is a file titled ``stats.yaml``. This file contains a ma Due to the fact that config variables are only available when the service is running, this file can only be populated at runtime. In services Start9 has wrapped or created, we typically handle this in ``configurator/src/main.rs``. This file is essentially a script that acquires the necessary values at runtime from config (eg. ``/root/.lnd/start9/config.yaml``), and dynamically populating them to the ``stats.yaml`` file, marking each value with the appropriate keys for UI display (ie. masked or copyable). Running the configurator is typically included in the ``docker_entrypoint.sh`` file. -A good example of the configurator producing the ``stats.yaml`` file can be found `here `_. .. role:: raw-html(raw) :format: html diff --git a/source/contributing/services/wrapper.rst b/source/contributing/services/wrapper.rst index 80bdeab..9f49880 100644 --- a/source/contributing/services/wrapper.rst +++ b/source/contributing/services/wrapper.rst @@ -48,7 +48,9 @@ Run ``git submodule add `` Assets ====== -*This section is being deprecated in favor of baking assets into the Docker image, and moved into the mountpoint at runtime if necessary* +.. warning:: + + *This section is being deprecated in favor of baking assets into the Docker image, and moved into the mountpoint at runtime if necessary* Whenever a service is stopped, any file that is not contained within in the ``/assets`` directory will be cleared from memory. Any unsaved changes will be reverted. This folder acts as a persistance storage container.