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,18 +0,0 @@
.. _packaging-references:
====================
Packaging References
====================
Below are links to working examples of more advanced configurations for current Embassy services. They might serve as a starting point or reference during your development process:
TODO update links when merged to master
- Detailed `docker_entrypoint.sh` - `Filebrowser <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/docker_entrypoint.sh>`_
- Optional dependencies - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/assets/compat/dependencies.yaml>`_
- Config spec - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/assets/compat/config_spec.yaml>`_
- Config rules - `BTC RPC Proxy <https://github.com/Start9Labs/btc-rpc-proxy-wrapper/blob/master/assets/compat/config_rules.yaml>`_
- Multiple dependencies - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/manifest.yaml#L172-L187>`_
- Actions - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/actions/btcpay-admin.sh>`_
- Health checks - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/assets/utils/health_check.sh>`_
- Alerts - `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/manifest.yaml#L207-L218>`_

View File

@@ -24,6 +24,8 @@ We recommend using the build in terminal as a command line interface (CLI) for y
If you are new to the command line, Ionic has published this awesome `guide <https://ionicframework.com/blog/new-to-the-command-line/>`_ to get you started.
.. _environment-setup-git:
Git
===
@@ -50,11 +52,12 @@ Cargo
Cargo is the package management solution for the Rust programming language. It will install Rust to your system, and provide the required environment to build the Embassy SDK for packaging your service into the required format needed by EmbassyOS.
Installation instructions for Cargo can be found `here <https://doc.rust-lang.org/cargo/getting-started/installation.html>`_.
Installation instructions for Cargo can be found `here <https://doc.rust-lang.org/cargo/getting-started/installation.html>`__.
To verify the installation, open a terminal window and run:
.. code:: bash
cargo --version
SDK
@@ -84,10 +87,11 @@ While not strictly necessary, having a running instance of EmbassyOS is recommen
You can acquire EmbassyOS by :ref:`purchasing <purchasing>` or following the :ref:`DIY guide <diy>`.
.. _quick-start:
Quick Start Environment Setup
=============================
- `Docker <https://docs.docker.com/get-docker>`_
- `Docker buildx <https://docs.docker.com/buildx/working-with-buildx/>`_
- `Cargo <https://doc.rust-lang.org/cargo/getting-started/installation.html>`_
- `Cargo <https://doc.rust-lang.org/cargo/getting-started/installation.html>`__
- `EmbassyOS <https://github.com/Start9Labs/embassy-os>`_
- `Embassy SDK <https://github.com/Start9Labs/embassy-os/blob/master/backend/install-sdk.sh>`_

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)