Dev docs edits / link fixes

2026-03-26 10:21:53 +00:00 · 2022-02-01 21:58:12 -07:00
parent 36b8d4b02d
commit 39363f64d1
11 changed files with 54 additions and 31 deletions
--- a/site/source/_static/images/services/service-properties.svg
+++ b/site/source/_static/images/services/service-properties.svg
--- a/site/source/learn/concepts/index.rst
+++ b/site/source/learn/concepts/index.rst
@@ -13,5 +13,4 @@ An overview of the ideas and technologies surrounding Start9 Labs and Embassy
  networks
  self-hosting
  embassy
-  .. software
  bitcoin-lightning
--- a/site/source/learn/concepts/software.rst
+++ b/site/source/learn/concepts/software.rst
@@ -1,12 +0,0 @@
-.. .. _software:
-
-.. ===================
-.. Associated Software
-.. ===================
-
-.. .. _firefox:
-
-.. Firefox
-.. -------
-
-.. firefox.com
--- a/site/source/support/dev-docs/packaging-example.rst
+++ b/site/source/support/dev-docs/packaging-example.rst
@@ -57,7 +57,7 @@ The package is made up of the following parts:
    #. License - The Open Source license of the service wapper.
    #. Icon - Image used to identify the service in the UI.

-The ``.s9pk`` is the image, manifest, license, icon, and instructions files bundled into a .s9pk package. Optional additional assets for use with system images can also be bundled. This is the file a user downloads from the Marketplace, at which point EOS uses to unpack assets and install the service.
+The ``.s9pk`` is the image, manifest, license, icon, and instructions files bundled into a package. Optional additional assets for use with system images can also be bundled. This is the file a user downloads from the Marketplace, at which point EOS uses to unpack assets and install the service.

 Check :ref:`here <service_package_overview>` for a detailed overview of package components.

@@ -66,7 +66,7 @@ Service Wrapper Repo and Submodules

 See :ref:`here <service_wrapper>` for how to structure your service wrapper's git repository.

-Git submodules allow the use of another project while in the working project directory.  In this case, you can use an existing app's git repo in order to source its code into your service wrapper.
+Git submodules allow the use of another project while in the working project directory.  In this case, you can use an existing app's git repo in order to source its code in your service wrapper.  You can add the submodule into the wrapper so that you can build the submodule and also track the exact code you're building.

 Simply run:

--- a/site/source/support/dev-docs/service-packaging/config.rst
+++ b/site/source/support/dev-docs/service-packaging/config.rst
@@ -1,8 +1,8 @@
 .. _service-config:

-=====================
-Service Configuration
-=====================
+=============
+Configuration
+=============

 Introduction
 ------------
--- a/site/source/support/dev-docs/service-packaging/instructions.rst
+++ b/site/source/support/dev-docs/service-packaging/instructions.rst
@@ -6,11 +6,49 @@ Instructions & Docs

 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:
+If an ``instructions.md`` file is included, this markdown formatted file will be rendered in the "Instructions" section within the service page on EmbassyOS:

-.. figure:: /_static/images/services/service-instruct.svg
-  :width: 80%
-  :alt: Embassy Pages Instructions
+  .. figure:: /_static/images/services/service-instruct.svg
+    :width: 80%
+    :alt: Embassy Pages Instructions
+
+Below is the markdown file for Embassy Pages' instructions, as shown above:
+
+  .. code-block:: markdown
+
+    # Embassy Pages
+
+    ## About
+
+    Embassy Pages is a simple web server that uses directories inside File Browser to serve Tor websites. Your website could be a blog, a resume, a portfolio, a business landing page, a product brochure, or just a set of static folders and/or files that you want to share with the world.
+
+    When you first install Embassy Pages, there will be a default Homepage hosted at the root, <tor-address>.onion. You can change the behavior of this page, and you can also create Subdomain websites. For example, one site could be hello.<tor-address>.onion and another could be goodbye.<tor-address>.onion. What is served from the Homepage and each Subdomain is totally up to you.
+
+    Self-hosting Tor  websites using Embassy Pages is easy, permissionless, and censorship-resistant; there are no trusted third parties involved.
+    Anyone can do it. No one can stop it.
+
+    ## Instructions
+
+    1. Inside `Config`, you can easily change the behavior of your Homepage to serve:
+      1. A list of hyperlinks to all your Subdomains
+      2. A personal web page
+      3. An automatic redirect to a Subdomain
+      4. A static web page that tells anyone visiting it to fuck off, politely.
+
+    2. Inside `Config`, you can create one or more Subdomains, giving each a unique name.
+
+    3. To serve a personal website, simply upload the website directory to File Browser. Then, inside the settings for a particular page (either your Homepage or a Subdomain), enter the path to that directory. For example, a path of websites/blog would tell Embassy Pages that it can find the blog website inside the websites directory in File Browser.
+
+    4. A list of all your Subdomains can be found inside the Properties section of your Embassy Pages service.
+
+    ## Restore from Backup
+
+    1. In `Config`, select "Restore from Backup".
+    2. After the restoration completes, navigate to the Marketplace.
+    3. Downgrade Embassy Pages.
+    4. Upgrade Embassy Pages to the latest version.
+    5. Start Embassy Pages.
+    6. Embassy Pages is now successfully restored!

 Example
 -------
--- a/site/source/support/dev-docs/service-packaging/properties.rst
+++ b/site/source/support/dev-docs/service-packaging/properties.rst
@@ -6,11 +6,11 @@ Properties

 The output of this step is a file titled ``stats.yaml``. This file contains a mapping of the values that will be displayed in the ``Properties`` section in a service's menu.

-.. figure:: /_static/images/services/props.svg
+.. figure:: /_static/images/services/service-properties.svg
  :width: 80%
  :alt: Service Properties

-  Service Properties Tab
+  Service Properties

 Due to the fact that config variables are only available when the service is running, this file can only be populated at runtime. In services Start9 has wrapped or created, we typically handle this in ``configurator/src/main.rs``. This file is essentially a script that acquires the necessary values at runtime from config (eg. ``/root/.lnd/start9/config.yaml``), and dynamically populating them to the ``stats.yaml`` file, marking each value with the appropriate keys for UI display (ie. masked or copyable). Running the configurator is typically included in the ``docker_entrypoint.sh`` file.

--- a/site/source/support/dev-docs/service-packaging/wrapper.rst
+++ b/site/source/support/dev-docs/service-packaging/wrapper.rst
@@ -37,6 +37,6 @@ The project structure should be used as a model:
 Submodule
 ---------

-`Git submodules <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 its context is available.
+`Git submodules <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 its context is available.  The submodule is added into the wrapper so that the wrapper can build the submodule and also track the exact code that's being built.

 Run ``git submodule add <link_to_source_project>``
--- a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst
+++ b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst
@@ -12,13 +12,13 @@ Nothing specific needs to be configured for the Linux environment, so you just n

 #. Navigate to the :ref:`Embassy tab<embassy-tab>` -> Settings -> LAN

-   .. figure:: /_static/images/embassy_lan_setup.svg
+   .. figure:: /_static/images/ssl/embassy_lan_setup.svg
    :width: 60%
    :alt: LAN setup menu item

 #. Click "Download Root CA". This will prompt a download to save the certificate file to your machine.

-   .. figure:: /_static/images/embassy_lan_setup0.svg
+   .. figure:: /_static/images/ssl/embassy_lan_setup0.svg
    :width: 60%
    :alt: LAN setup page

--- a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst
+++ b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst
@@ -22,13 +22,13 @@ Unfortunately, Windows does not have mDNS support built-in, which is necessary i

 #. Navigate to the :ref:`Embassy tab<embassy-tab>` -> Settings -> LAN

-   .. figure:: /_static/images/embassy_lan_setup.svg
+   .. figure:: /_static/images/ssl/embassy_lan_setup.svg
    :width: 90%
    :alt: LAN setup menu item

 #. Click "Download Root CA". This will prompt a download to save the certificate file to your machine.

-   .. figure:: /_static/images/embassy_lan_setup0.svg
+   .. figure:: /_static/images/ssl/embassy_lan_setup0.svg
    :width: 90%
    :alt: LAN setup page