mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 04:01:59 +00:00
few more fixes
This commit is contained in:
@@ -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 <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs>`_ demonstrates a good use of instructions and external integrations.
|
|
||||||
|
|
||||||
.. role:: raw-html(raw)
|
|
||||||
:format: html
|
|
||||||
|
|
||||||
:raw-html:`<br />`
|
|
||||||
@@ -30,7 +30,7 @@ Happy building!
|
|||||||
Makefile <makefile>
|
Makefile <makefile>
|
||||||
Config <config>
|
Config <config>
|
||||||
Properties <properties>
|
Properties <properties>
|
||||||
Docs <docs>
|
Instructions <instructions>
|
||||||
|
|
||||||
Submission process
|
Submission process
|
||||||
------------------
|
------------------
|
||||||
|
|||||||
@@ -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.
|
Below are the types and sub-type definitions, with necessary elaborations. Any item that contains ``Option<>`` is an optional field.
|
||||||
|
|
||||||
Example
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. code:: yaml
|
.. code:: yaml
|
||||||
|
|
||||||
# manifest version compatibility ie. v0 (this is currently the only option)
|
# manifest version compatibility ie. v0 (this is currently the only option)
|
||||||
@@ -87,7 +84,7 @@ Example
|
|||||||
.. _dependencies:
|
.. _dependencies:
|
||||||
|
|
||||||
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.
|
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.
|
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:
|
Types for ``manifest.yaml`` fields:
|
||||||
|
|
||||||
.. code:: typescript
|
.. code:: typescript
|
||||||
@@ -170,8 +170,6 @@ Types for ``manifest.yaml`` fields:
|
|||||||
|
|
||||||
:raw-html:`<br />`
|
:raw-html:`<br />`
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ The project structure should be used as a model:
|
|||||||
Submodule
|
Submodule
|
||||||
==========
|
==========
|
||||||
|
|
||||||
`Git sub-modules <https://www.git-scm.com/book/en/v2/Git-Tools-Submodules>>`_ 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 <https://www.git-scm.com/book/en/v2/Git-Tools-Submodules>`_ 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 <link_to_source_project>``
|
Run ``git submodule add <link_to_source_project>``
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user