Services, misc edits

site/source/support/user-manual/services/managing-services/index.rst

@@ -0,0 +1,20 @@
+.. _managing-services:
+
+=================
+Managing Services
+=================
+
+An overview of Services and Marketplaces on EmbassyOS.
+
+.. toctree::
+  :maxdepth: 2
+
+  service-overview
+  service-install
+  service-config
+  service-instructions
+  service-actions
+  service-interfaces
+  service-logs
+  service-marketplace
+  service-donate

site/source/support/user-manual/services/managing-services/service-actions.rst

@@ -0,0 +1,19 @@
+.. _actions:
+
+=======
+Actions
+=======
+
+Actions are defined by the service package developer, and can provide the ability to do resets or other miscellaneous administrative tasks.  The most simple of these is to remove a service from your Embassy.
+
+.. _uninstalling:
+
+Un-installing
+-------------
+
+.. warning:: THIS WILL DELETE ALL DATA FOR THIS SERVICE, PLEASE BE SURE YOU WANT TO DO THIS!
+
+To remove a service, navigate to the :ref:`Services tab<services-tab>` *> [Service Name] > Actions > Uninstall*.
+
+    .. figure:: /_static/images/services/acts.svg
+        :width: 60%

site/source/support/user-manual/services/managing-services/service-config.rst

@@ -0,0 +1,27 @@
+.. _service-config:
+
+=============
+Configuration
+=============
+
+After installation or update, some services require configuration before they can be started.
+
+Navigate to the `Services tab <services-tab>` *> [Service Name] > Config*
+
+    .. figure:: /_static/images/services/service-needs-config.svg
+        :width: 60%
+
+Traditionally, configuring services was a massive headache and a huge barrier to running a personal server. But no more! The Embassy's revolutionary service config system makes the process transparent, simple, and safe.
+
+    .. figure:: /_static/images/services/service4.svg
+        :width: 60%
+
+Config options are defined by the service developer and can be almost anything. They are represented as simple UI elements - such as toggles and drop downs - and they include explanations and validations, such that users understand their purpose and are prevented from making mistakes.
+
+    .. figure:: /_static/images/services/service5.svg
+        :width: 60%
+
+You can change your configuration at any time from a Service's main page:
+
+    .. figure:: /_static/images/services/config.svg
+        :width: 60%

site/source/support/user-manual/services/managing-services/service-donate.rst

@@ -0,0 +1,17 @@
+.. _service-donate:
+
+======
+Donate
+======
+
+Currently, this is a link provided by the service package developer so that you may donate to them or the developer of the service they packaged directly.  If this is not provided, a pop-up message will let you know this, and you will need to find the devs on their own platforms in order to donate.
+
+    .. figure:: /_static/images/services/donate.png
+        :width: 60%
+
+        Donate
+
+.. topic-box::
+    :title: Looking Forward
+
+    We intend to leverage the power of Embassy's Lightning Network options to create the choice for a user to immediately send sats to a developer.  Ideally, this will have a percentage breakdown for the service developer, service packager, and Start9, for the user to delegate their donation as they choose.  We are serious about helping to incentivize :ref:`Open Source<open-source>` development.

site/source/support/user-manual/services/managing-services/service-install.rst

@@ -0,0 +1,32 @@
+.. _installing:
+
+==========
+Installing
+==========
+
+.. note:: Some services have :ref:`dependencies<service-dependencies>` on other services. Adding, updating, or removing a service can sometimes have requirements or consequences for other services. Your Embassy will always inform you of these issues along the way.
+
+To add a new service, simply find it's listing inside the :ref:`Service Marketplace <service-marketplace>` tab: *[Service Name] >* ``Install``.  Let's install Synapse as an example:
+
+    .. figure:: /_static/images/services/service0.svg
+        :width: 60%
+
+    .. figure:: /_static/images/services/service1.svg
+        :width: 60%
+
+Depending on the size of the service and your Internet connection, installation should take between 60 seconds and a few minutes.
+
+    .. figure:: /_static/images/services/service2.svg
+        :width: 60%
+
+You may click *View Service* at any time to view install progress, or after install to go to the Service page.  Many services will need to be configured after install.  You can use the default options, or change to your liking.  See :ref:`configuration<service-config>` for details.
+
+    .. figure:: /_static/images/services/service3.svg
+        :width: 60%
+
+You will see a screen like the following when install is complete.  Then you're ready to :ref:`configure <service-config>` your service!
+
+    .. figure:: /_static/images/services/service4.svg
+        :width: 60%
+
+.. note:: You can only use a service once its :ref:`dependencies <service-dependencies>` are met, its :ref:`configuration<service-config>` is complete, it has been started, and is in a *running* :ref:`status <service-status>`.

site/source/support/user-manual/services/managing-services/service-instructions.rst

@@ -0,0 +1,17 @@
+.. _instructions:
+
+============
+Instructions
+============
+
+To view the instructions for a particular service, navigate to the :ref:`Services tab <services-tab>` *> [Service Name] > Instructions*.
+
+.. figure:: /_static/images/services/instruct.svg
+  :width: 60%
+
+Instructions will provide you with service-specific direction, provided by the service package developer, on what to expect, and how to use your new service.
+
+.. figure:: /_static/images/services/service-instruct.svg
+  :width: 60%
+
+.. note:: For advanced instructions and integration guides, visit the wrapper repository for an `available service <https://marketplace.start9.com>`_.

site/source/support/user-manual/services/managing-services/service-interfaces.rst

@@ -0,0 +1,7 @@
+.. _interfaces:
+
+==========
+Interfaces
+==========
+
+

site/source/support/user-manual/services/managing-services/service-logs.rst

@@ -0,0 +1,9 @@
+.. _logs:
+
+====
+Logs
+====
+
+Naviage to *Services > [Service Name] > Logs*
+
+Every service emits logs while it is in a *running* state. Logs give an *under-the-hood* glimpse of a service and can be extremely useful for debugging purposes. To a non-technical user, logs may look like gibberish, and sometimes there is nothing to see at all.

site/source/support/user-manual/services/managing-services/service-overview.rst

@@ -0,0 +1,38 @@
+.. _service-overview:
+
+=================
+Services Overview
+=================
+
+Services are very similar to Applications on a mobile device.  The biggest differences are that they are often designed to run constantly, with 24/7 availability for when a user requires them.  This is why they are called :ref:`Services<services>`, they are always ready to serve users!
+
+
+The Service Page
+----------------
+
+.. figure:: /_static/images/services/service8.svg
+    :width: 60%
+
+    The Service Page
+
+In the image above, we see an example of a Service's homescreen, where you can access all the information and utilities of a particular service.
+
+Below, we highlight the quick, need-to-know information of a Service that a user will want to see right away.
+
+.. figure:: /_static/images/services/service00.svg
+    :width: 60%
+
+.. _service-status:
+
+We can see the Service (Embassy Pages in this case), its ``Status``, ``Health Checks`` (if it has any), ``Dependencies`` (if it has any), and the ability to ``Start`` or ``Stop`` the Service, as well as ``Launch UI`` if it has a :ref:`Web Interface <web-ui>`.  Here's a breakdown of what each of these means:
+
+    - Status:
+        - Needs Config: The Service needs your attention in making a configuration decision.  There will always be default options available to you.
+        - Stopping... : Service is being stopped
+        - Stopped: Service is installed and configured, but not currently running.
+        - Starting... : Service is booting up
+        - Running: Service is running
+    - Health Checks: This is a critical feature of EmbassyOS.  Health Checks are configured by the service packager in order to quickly convey to the user what is happening with their service, and possible actions they may want to take.  Learn more about :ref:`Health Checks <health-checks>`.
+    - Dependencies: A service may require another service, called a dependency, in order to work.  These may be optional, or required.  Learn more about :ref:`Dependencies <service-dependencies>`.
+    - Start / Stop: Self-explanatory, use these buttons to start or stop a service.
+    - Launch UI: If available, this will open the User Interface (UI) for the service in a new browser tab.  Learn more about :ref:`Web UIs<web-ui>`.

site/source/support/user-manual/services/managing-services/service-properties

@@ -0,0 +1,15 @@
+.. _properties:
+
+==========
+Properties
+==========
+
+Navigate to *Services > [Service Name] > Properties*
+
+Properties are both static and dynamic information about a service. They could be almost anything: a default username/password, an invite code, or a list of peers - anything the service developer thought might be useful.
+
+Properties may be accompanied by one or more of the following:
+
+* a *help* icon for further explanation.
+* a *copy* icon for copying the value to your clipboard.
+* a *QR* icon for viewing the value as a QR code.

site/source/support/user-manual/services/managing-services/service-updates.rst

@@ -0,0 +1,9 @@
+.. _updates:
+
+========
+Updating
+========
+
+To see if an update is available for a service, you can visit the *updates* section of the Marketplace or by visiting its Marketplace listing.
+
+If an update is available, simply click "Update" and confirm the action.