yank external manuals, update faq and service instructions

README.md

@@ -31,16 +31,6 @@ If any css or table of contents organization changes, run: `make clean html`.
 
 If you notice a mistake in the docs, or you have an idea for improving them, we would like to know about it. You can either fix the mistake yourself and submit a pull request, or you can report the mistake by submitting an issue.
 
-### Guide Templates
-
-We welcome contributions to add a guide to this documentation repository. Please reference the template [here](source/contributing/template.rst) and use proper restructured text syntax. 
-
-Guides should live under `./source/user-manuals/external`. If they are bitcoin related, add a section title for the next integration guide in the `bitcoin.rst` page. If the guide belongs in a new topic, create a new `.rst` file with an appropriate name following the template conventions. Don't forget to include the new page in the `index.rst` file toctree within the external folder.
-
-All images should be placed in `./source/_static/images` with descriptive labeling. 
-
-Figure directives should include an alt description.
-
 ### Submitting an issue
 
 Click on the "Issues" tab in the top navbar. Provide a good title and describe clearly the mistake or improvement.

source/available-services/index.rst

@@ -0,0 +1,13 @@
+.. _available-services:
+
+******************
+Available Services
+******************
+
+`Bitcoin <https://github.com/Start9Labs/bitcoind-wrapper>`_
+
+`Bitwarden <https://github.com/Start9Labs/filebrowser-wrapper>`_
+
+`Cups <https://github.com/Start9Labs/cups-wrapper>`_
+
+`File Browser <https://github.com/Start9Labs/filebrowser-wrapper>`_

source/conf.py

@@ -76,7 +76,7 @@ html_theme_options = {
     "extra_navbar": "",
 }
 html_logo = "_static/logo.png"
-html_title = "Docs"
+html_title = "Start9 Labs"
 html_favicon = "_static/favicon.ico"
 html_js_files = [
     'js/main.js'

source/contributing/template.rst

@@ -1,47 +0,0 @@
-.. _template: 
-
-.. this is a comment
-.. above is how you create an internal link so you can reference this page like :ref:`desired text<template>`
-.. link name must be unique
-
-********
-Template
-********
-
-A description of this page overall. For more info on ``rst`` syntax, check out this `cheat sheet <https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html>`_.
-
-Section Title 1
-===============
-
-A description of the section.
-
-  Here is an indented section.
-
-Sub-title 1
------------
-
-For referencing ``inline code``.
-
-An `external link <https://start9labs.com>`_ within a sentence. 
-
-.. figure:: /_static/images/bengal_cat.jpg
-  :width: 50%
-  :alt: Test figure
-
-  Here is a figure title. This image will only display in the live documentation.
-
-Sub-title 2
------------
-
-Some more steps outlined here.
-
-.. note:: A note with further explanations. 
-
-Section Title 2
-================
-
-This section includes a code block:
-
-.. code:: javascript
-
-  console.log("hello world")

source/index.rst

@@ -19,14 +19,12 @@ Here you will find guidance and information about the Start9 Embassy personal se
 
   user-manuals/embassyos/index
   user-manuals/services/index
-  user-manuals/external/index
 
 .. toctree::
   :maxdepth: 2
   :caption: Contributing
 
   contributing/adding-services
-  contributing/template
 
 .. toctree::
   :maxdepth: 2

source/support/faq.rst

@@ -86,3 +86,17 @@ Is there a product warranty?
 Yes. Start9 commits to serving each beta Embassy product released until the wild. We commit, to the best of our ability, to resolve any issue encountered with our provided hardware or software in a personalized matter until resolved.
 
 Do not hesitate to :ref:`contact`. We strive to also provide quality and available customer service upfront. 
+
+
+Can I run EmbassyOS on a VPS or VM?
+===================================
+
+No, and we do not advise this. It is designed to be used on a RaspberryPi.
+
+
+Is it possible to DIY the EmbassyOS on my own hardware?
+=======================================================
+
+In the near future, you will be able to purchase EmbassyOS from us online. This will be great for people who already own the necessary hardware or who live outside the US and want to save on shipping and customs fees.
+
+Additionally, the source code will soon be made available online. If you have the time and energy, it will be possible to download and compile EmbassyOS yourself, for free, with the caveat that your "Embassy" will not have a product key generated by us. This means you will miss out on the perks that come along with purchasing from us, which will grow over time.

source/user-manuals/external/bitcoin.rst

@@ -1,140 +0,0 @@
-*******
-Bitcoin
-*******
-
-The Tor address provided by the Bitcoin service can be used in the configuration settings for wallet applications.
-
-Specter Desktop
-===============
-
-This guide was written for MacOS on Catalina 10.15.7 courtesy of @Chiefmonkey.
-
-Step 1 - Install Homebrew
--------------------------
-
-If you do not have Homebrew installed, go to https://brew.sh/ and install it by opening up the command line editor (Terminal) and cut’n’paste the line from Homebrew that looks like this:
-
-``/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"``
-
-It will ask you for your system password before it installs:
-
-.. figure:: /_static/images/specter/install-homebrew.png
-  :width: 90%
-  :alt: Homebrew installation
-
-It will tell you which directories it’s going to create and hit ``return``:
-
-.. figure:: /_static/images/specter/install-homebrew1.png
-  :width: 90%
-  :alt: Homebrew directories
-
-It creates the directories and downloads any other files it needs e.g. “Command Line Tool for Xcode” and “Homebrew”.
-Wait 5 minutes whilst it downloads and installs what it needs.
-
-Surprisingly, Homebrew uses Google Analytics to collect anonymous usage data. You can deselect the option to share usage data `by opting out <https://docs.brew.sh/Analytics#opting-out>`_.
-
-
-Step 2 - Install Tor
---------------------
-
-.. note:: Close Tor Browser before you edit your ``torrc``, otherwise Tor Browser may erase your modifications.
-
-In the command line type: ``brew install tor``
-
-See `the tor project <https://2019.www.torproject.org/docs/tor-doc-osx.html.en>`_ for more details.
-
-Once it’s finished you have the following options:
-
-.. figure:: /_static/images/specter/install_tor.png
-  :width: 90%
-  :alt: Install Tor
-
-Step 3 - Edit torrc config file
--------------------------------
-
-Once tor is installed you will need to edit the tor config file. You can do this using Finder, or via the command line if you are a developer. Reference `these <https://support.torproject.org/tbb/tbb-editing-torrc/>`_ instructions for the Finder approach.
-
-Newer Macs hide certain files like torrc so you need to do do this:
-
-Open Finder and click Go menu > Go to Folder
-
-.. figure:: /_static/images/specter/go-to-folder.png
-  :width: 40%
-  :alt: Mac go to folder menu
-
-Then enter:
-
-``~/Library/Application Support/TorBrowser-Data/Tor``
-
-.. figure:: /_static/images/specter/go-to-folder2.png
-  :width: 70%
-  :alt: Mac go to folder submenu
-
-This will display all hidden folders in that folder.
-
-The hidden folder will open, and you can right click the torrc file to open with a text editor:
-
-.. figure:: /_static/images/specter/edit-tor-config1.png
-  :width: 90%
-  :alt: Edit torrc file
-
-Copy the following lines into your torrc file if they do not exist already:
-
-.. code:: bash
-
-    ## The port on which Tor will listen for local connections from Tor
-    ## controller applications, as documented in control-spec.txt.
-    ControlPort 9051
-    CookieAuthentication 1
-    CookieAuthFileGroupReadable 1
-
-
-.. note:: For further help or reference, visit the `specter desktop docs <https://github.com/cryptoadvance/specter-desktop/blob/master/docs/tor.md#install-tor-service>`_ here. 
-
-
-Step 4 - Reboot
----------------
-
-Reboot your machine.
-
-Step 5 - Configure Specter Desktop App
---------------------------------------
-
-`Download <https://specter.solutions/>`_ specter.
-
-Under “Wallets” on the left click ``Configure``.
-
-Turn off Auto-detect.
-
-.. figure:: /_static/images/specter/specter-desktop.png
-  :width: 75%
-  :alt: Specter desktop
-
-In a Tor enabled browser connected to your Embassy click: ``Services > Bitcoin Core`` and copy your Tor address.
-
-.. figure:: /_static/images/specter/embassy1.png
-  :width: 90%
-  :alt: Embassy Bitcoin service menu
-
-
-Paste it into Specter in the Host field.
-
-Go back to your Embassy to get your Username and Password by selecting: ``Config > RPC Settings``.
-
-Go back to Specter and fill it out like this:
-
-.. figure:: /_static/images/specter/specter-desktop.png
-  :width: 75%
-  :alt: Specter desktop
-
-Click “Test”. It can take a few minutes.
-
-If all is well several green checkboxes will appear and some config settings:
-
-.. figure:: /_static/images/specter/specter-desktop2.png
-  :width: 75%
-  :alt: Specter desktop config
-
-Click “Save”.
-
-Have a beer and some tacos before journeying further into the rabbit hole.

source/user-manuals/external/index.rst

@@ -1,10 +0,0 @@
-************
-Integrations
-************
-
-Various third-party applications can be integrated with the Embassy's services. Linked below are guides for such integrations.
-
-.. toctree::
-  :maxdepth: 2
-
-  bitcoin

source/user-manuals/services/index.rst

@@ -2,23 +2,18 @@
 Services
 ********
 
-To view the instructions for a particular service, navigating to ``Services > [Service Name] > Instructions``
+Services are self-hosted, open source projects made compatible for EmbassyOS. Each service is has been independently developed by members of the open source community. The Embassy enables configuration, customization and a one click install.
 
 .. note:: Some services require configuration before starting up. You can only connect to and use a service once it is in a *running* state.
 
-
+Features
-`Bitcoin <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/instructions.md>`_
+========
-
-`Bitwarden <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/docs/instructions.md>`_
-
-`Cups <https://github.com/Start9Labs/cups-wrapper/blob/master/docs/instructions.md>`_
-
-`File Browser <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/docs/instructions.md>`_
 
 .. toctree::
   :maxdepth: 2
 
   installing
+  instructions
   backups
   service-config
   properties

source/user-manuals/services/instructions.rst

@@ -0,0 +1,19 @@
+************
+Instructions
+************
+
+To view the instructions for a particular service, navigate to ``Services > [Service Name] > Instructions``.
+
+.. figure:: /_static/images/bitcoin_instructions.png
+  :width: 90%
+  :alt: Bitcoin instructions menu item
+
+  Instructions menu item
+
+.. figure:: /_static/images/bitcoin_instructions_view.png
+  :width: 90%
+  :alt: Bitcoin instructions view
+
+  Instructions view
+
+.. note:: For advanced instructions and integration guides, visit the wrapper repository for an :ref:`available service <available-services>`.