Merge pull request #49 from Start9Labs/integration/0.3.0

0.3.0 Docs

.gitignore

@@ -2,6 +2,5 @@
 .vscode/
 build-send.sh
 site/_build
-site/_utils/docsearch_config.json
-site/_utils/docsearch_index.js
 .env
+site/_utils/docsearch*

README.md

@@ -25,8 +25,46 @@ The [extension](https://github.com/Holzhaus/sphinx-multiversion) used to build d
 
 ## Dependencies
 
+Install [python3] (https://www.python.org/downloads/)
+Install [poetry] (https://python-poetry.org/docs/)
 Install [pyenv](https://github.com/pyenv/pyenv)
 
+For installations with MacOS:
+
+```
+brew install python3
+brew install poetry
+```
+
+## Project Setup
+
+1. Clone this repository and enter the project folder:
+
+```
+git clone https://github.com/Start9Labs/documentation.git && cd documentation
+```
+
+2. Install theme submodule:
+
+```
+git submodule update --init
+```
+
+3. (Optional, if you have an older build that needs to be updated) Navigate to `sphinx-scylladb-theme`, update and build with:
+
+```
+cd sphinx-scylladb-theme
+git pull
+npm i
+npm run build
+```
+
+4. Navigate to the `site` folder and start the project:
+
+```
+cd site
+make clean && make preview
+```
 ## Development
 
 When editing these files, begin a livereload environment by running `make preview` while in the `./site/` directory.

site/03-todo.md

@@ -0,0 +1,36 @@
+# TODO
+- Update all guides in service repos (link to wrapper repos in service guides)
+    - Lightning (Zeus)
+    - Vaultwarden needs screens
+- Verify LAN and Tor setup steps on a Mac
+- Refactor and update Roadmap
+- Add / verify ALL links in the **UI** go to the right place in docs
+- Initial Setup
+- Alt Market Switching
+- Migration / Recovery
+- Backups
+    - CIFS
+        - OS guides for CIFS
+    - Local
+    - Restore from backup
+- Mission / values
+- Synology
+
+# BLOCKED:
+- Possible sounds in troubleshooting (and walkthrough?)
+- Alt Market Build Guide
+- Launch versioned site/docs to start9.com
+- Verify ALL links (especially in device guides as they are all external)
+
+# AFTER PUBLISHING:
+- Create badges for device guide topic boxes <connectivity, performance, resilience and/or tuning>
+- Close all relevant issues (some await new processes in order to test)
+- Migrate from other server projects / nodes (currently punted)
+- Breakout Bitcoin / Lightning integrations into their own individual pages
+
+Go to the Synology UI > Control Panel > Shared Folder > select the folder you want to use > Permissions tab > make sure that you have read/write permissions for the user you're going to be logging in as (probably unnecessary but I made a separate user for this to keep things segregated) > Save
+Then go to the Synology UI > Control Panel > File Services > SMB Tab > Click the SMB drop down button if it isn't already selected > Ensure that "Enable SMB service" is checked.
+Under Advanced Settings on the same dropdown I have "Min SMB protocol" set to SMB2 and "Max SMB protocol set to SMB3", I got the impression somewhere that it might be important but I don't know if those are default values or if they actually matter).
+On the same dropdown, under "Note" will be "PC (Windows Explorer): \". This DeviceAddressName is the "Hostname" within the Embassy New Shared Folder dialog, and note that it is case sensitive and that the \ have been removed.
+Go to Synology UI > File Station > navigate so that you can see the the desired destination folder > right click on it > Properties > General Tab, next to Location: will be an folder location of the format ///, the / portion (so without the volume label) is the "Path" within the Embassy New Shared Folder dialog.
+Fill in the Username and Password appropriately for the previously checked user.

site/_utils/setup.sh

@@ -6,6 +6,7 @@ if pwd | egrep -q '\s'; then
 fi
 
 which python3 || { echo "Failed to find python3. Try installing Python for your operative system: https://www.python.org/downloads/" && exit 1; }
-which poetry || curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/1.1.3/get-poetry.py | python3 - && source ${HOME}/.poetry/env
+which poetry || curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py  | python3 - && source ${HOME}/.poetry/env
+
 poetry install
 poetry update

site/source/_static/custom.js

@@ -0,0 +1,16 @@
+
+window.jQuery = $;
+window.$ = $;
+
+const hideHeaderLinks = () => {
+  const dropdownHeader = $(".scylla-dropdown--header");
+  const urlVersion = window.location.pathname.includes("0.2.x");
+  if (urlVersion) {
+    dropdownHeader.hide();
+  }
+};
+
+
+$(document).ready(function () {
+    hideHeaderLinks();
+});