From 41d41dad86a39b7970397bd56404060cef29a888 Mon Sep 17 00:00:00 2001 From: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Date: Wed, 10 Feb 2021 12:15:46 -0700 Subject: [PATCH] few more fixes --- source/contributing/services/docs.rst | 23 ----------------------- source/contributing/services/index.rst | 2 +- source/contributing/services/manifest.rst | 10 ++++------ source/contributing/services/wrapper.rst | 2 +- 4 files changed, 6 insertions(+), 31 deletions(-) delete mode 100644 source/contributing/services/docs.rst diff --git a/source/contributing/services/docs.rst b/source/contributing/services/docs.rst deleted file mode 100644 index 6f8e7de..0000000 --- a/source/contributing/services/docs.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _service_docs: - -********************* -Service Documentation -********************* - -Within each wrapper repository should exist a ``docs`` directory. This folder should include any pertinent documentation, instructions, external integrations, or other details about the service that users or developers might find relevant. - -If an ``instructions.md`` file is included, this markdown formatted file will be rendered in the "Instructions" tab within the service detail menu on EmbassyOS: - -.. figure:: /_static/images/service/bitcoin_instructions.png - :width: 80% - :alt: Bitcoin Instructions - -Example -======= - -The `bitcoind wrapper `_ demonstrates a good use of instructions and external integrations. - -.. role:: raw-html(raw) - :format: html - -:raw-html:`
` \ No newline at end of file diff --git a/source/contributing/services/index.rst b/source/contributing/services/index.rst index 31d0315..c4c3475 100644 --- a/source/contributing/services/index.rst +++ b/source/contributing/services/index.rst @@ -30,7 +30,7 @@ Happy building! Makefile Config Properties - Docs + Instructions Submission process ------------------ diff --git a/source/contributing/services/manifest.rst b/source/contributing/services/manifest.rst index 73ea7e1..452bf16 100644 --- a/source/contributing/services/manifest.rst +++ b/source/contributing/services/manifest.rst @@ -31,9 +31,6 @@ Type definitions ================ Below are the types and sub-type definitions, with necessary elaborations. Any item that contains ``Option<>`` is an optional field. -Example -======= - .. code:: yaml # manifest version compatibility ie. v0 (this is currently the only option) @@ -87,7 +84,7 @@ Example .. _dependencies: Dependencies ------------- +============ Many services depend on other libraries and services on EmbassyOS (such as Bitcoin), sometimes even a particular version of those services, which need to be specified by the developers so that EmbassyOS can handle installing these dependencies under the hood. @@ -120,6 +117,9 @@ Let's take this snippet for example: The service ``btc-rpc-proxy`` is a dependency of the service ``c-lightning``. ``c-lightning`` requires it to be installed at a version >=0.1.0 <0.2.0. There exists a rule that states the config option ``user.name`` must be equal to "c-lightning". If this value does not exist for ``user.name`` when accessed, ``PUSH`` the value "c-lighting" to the field. +Type definitions +---------------- + Types for ``manifest.yaml`` fields: .. code:: typescript @@ -170,8 +170,6 @@ Types for ``manifest.yaml`` fields: :raw-html:`
` ----- - Examples -------- diff --git a/source/contributing/services/wrapper.rst b/source/contributing/services/wrapper.rst index 9f49880..6104e9d 100644 --- a/source/contributing/services/wrapper.rst +++ b/source/contributing/services/wrapper.rst @@ -41,7 +41,7 @@ The project structure should be used as a model: Submodule ========== -`Git sub-modules >`_ allow use of another project while in the working project directory. Setting up this feature enables linking of the source service repository so that it's context is available. +`Git sub-modules `_ allow use of another project while in the working project directory. Setting up this feature enables linking of the source service repository so that it's context is available. Run ``git submodule add ``