fix links and references so no compilation errors

This commit is contained in:
Lucy Cifferello
2022-02-13 19:10:23 -07:00
parent 10f352cd66
commit 10a5bcac98
17 changed files with 43 additions and 48 deletions

View File

@@ -1,4 +1,4 @@
.. _service-config:
.. _configuration:
=============
Configuration

View File

@@ -0,0 +1,7 @@
.. _dependencies:
============
Dependencies
============
TODO

View File

@@ -10,13 +10,14 @@ The following guides provide an in depth overview of the full capabilities avail
:hidden:
overview
wrapper
docker
manifest
emver
docker
makefile
config
properties
instructions
dependencies
backups
instructions
wrapper
makefile
submission

View File

@@ -352,9 +352,9 @@ Types for ``manifest.yaml`` fields: TODO check accuracy
Examples
========
- `filebrowser <>`_
- `embassy-pages <>`_
- `photoview <>`_
- `btcpayserver <>`_
- `lnd <>`_
- `synapse <>`_
- `Hello World <https://github.com/Start9Labs/hello-world-wrapper/blob/master/manifest.yaml>`__
- `Filebrowser <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/manifest.yaml>`__
- `Embassy-pages <https://github.com/Start9Labs/embassy-pages-wrapper/blob/master/manifest.toml>`__
- `Photoview <https://github.com/Start9Labs/embassyos-photoview-wrapper/blob/master/manifest.yaml>`__
- `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/manifest.yaml>`__
- `Synapse <https://github.com/Start9Labs/synapse-wrapper/blob/master/manifest.yaml>`__

View File

@@ -42,7 +42,7 @@ Image
Each service boils down to a Docker image. We're not going to dive into Docker specifics in this guide, since there exists tons of `resources <https://docs.docker.com/>`_ for developing with this containerization tool.
Because the service ultimately runs on a Raspberry Pi, the created Docker image should be a snapshot of an arm based linux environment. The service image is then mounted to the EmbassyOS image during installation. This path is defined in the :ref:`manifest <service-manifest>` configuration file.
Because the service ultimately runs on a Raspberry Pi, the created Docker image should be a snapshot of an arm based linux environment. The service image is then mounted to the EmbassyOS image during installation. This path is defined in the :ref:`manifest <service_manifest>` configuration file.
The image is immutable, meaning that when the service is updated, the image is replaced with a completely new image containing the updated features.
@@ -98,7 +98,7 @@ The configuration and manifest files get bundled into the ``.s9pk`` package, whi
Hello World Example
===================
For reference, the `Hello world <https://github.com/Start9Labs/hello-world-wrapper>`_ repository should be used as an example. A project template can be cloned using the "Use this template" button in GitHub. For a detailed walkthrough of this example, please see the :ref:`Packaging Example<packaging-example>`.
For reference, the `Hello World <https://github.com/Start9Labs/hello-world-wrapper>`__ repository should be used as an example. A project template can be cloned using the "Use this template" button in GitHub. For a detailed walkthrough of this example, please see the :ref:`Packaging Example <build-package-example>`.
.. role:: raw-html(raw)