Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 12:11:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Walkthrough, services complete. Misc edits

Browse Source
This commit is contained in:
kn0wmad
2022-01-07 13:14:48 -07:00
committed by Lucy Cifferello
parent d63695585e
commit 754abf22bf
24 changed files with 100 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -13,6 +13,7 @@ An overview of Services and Marketplaces on EmbassyOS.
service-install
service-config
service-instructions
service-properties
service-actions
service-interfaces
service-logs

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

@@ -9,8 +9,6 @@ Currently, this is a link provided by the service package developer so that you
.. figure:: /_static/images/services/donate.svg
:width: 60%
Donate
.. topic-box::
:title: Looking Forward

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

@@ -1,7 +1,15 @@
.. _interfaces:
.. _service-interfaces:
==========
Interfaces
==========
Interfaces are URLs that a :ref:`Service<services>` uses to communicate in various ways with other software. Many Services will only have one interface, perhaps with a Tor and LAN address, to denote where it is hosted / accessed. Other services, such as Bitcoin or Lightning Nodes, may have several interfaces for different use-cases.
.. figure:: /_static/images/services/service-ints.svg
:width: 60%
To view the instructions for a particular service, navigate to the :ref:`Services tab <services-tab>` *> [Service Name] > Properties*. From there you can copy a URL to your clipboard for use with external software.
.. figure:: /_static/images/services/service-ints0.svg
:width: 60%

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

@@ -1,4 +1,4 @@
.. _logs:
.. _service-logs:
====
Logs
@@ -6,4 +6,7 @@ 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.
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. You can check here if you have an issue with a service, and if you are talking to support, they may ask you to screenshot or copy these logs to help discover the root of the problem.
.. figure:: /_static/images/services/logs.svg
:width: 60%

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

@@ -6,6 +6,7 @@ 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!
.. _service-page:
The Service Page
----------------

15
site/source/support/user-manual/services/managing-services/service-properties
View File

@@ -1,15 +0,0 @@
.. _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.

20
site/source/support/user-manual/services/managing-services/service-properties.rst Normal file
View File

@@ -0,0 +1,20 @@
.. _service-properties:
==========
Properties
==========
Properties can contain 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.
.. figure:: /_static/images/services/props.svg
:width: 60%
To view the instructions for a particular service, navigate to the :ref:`Services tab <services-tab>` *> [Service Name] > Properties*.
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.
.. note:: Some services do not have any information in the Properties section

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

@@ -1,9 +1,9 @@
.. _updates:
.. _service-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.
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.