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

typos and mobile stlying

Browse Source
This commit is contained in:
Lucy Cifferello
2020-10-08 12:22:27 -06:00
parent efa97913c0
commit be80a9aeb2
13 changed files with 26 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
source/_static/default.css
View File

@@ -70,6 +70,12 @@ h1, h2 {
}
}
li .current {
ul .current li .current {
text-decoration: underline #f8f8ff;
}
@media (max-width: 768px) {
#site-navigation {
background-color: #2b2b2b;
}
}

1
source/conf.py
View File

@@ -73,6 +73,7 @@ html_theme_options = {
"use_edit_page_button": True,
"use_issues_button": True,
"use_repository_button": True,
"extra_navbar": "",
}
html_logo = "_static/logo.png"
html_title = ""

6
source/getting-started/connecting.rst
View File

@@ -4,7 +4,7 @@
Connecting
**********
With the :ref:`initial-setup` complete, your Embassy is now privately hosted on the Internet and can be accessed right from the borwser. Your Embassy's addresses (its Tor and LAN URLs) are completely private; no one else even knows they exists.
With the :ref:`initial-setup` complete, your Embassy is now privately hosted on the Internet and can be accessed right from the browsers. Your Embassy's addresses (its Tor and LAN URLs) are completely private; no one else even knows they exists.
If you accidentally leak your Embassy's addresses, do not worry. You Embassy is also protected by your password; so only you can log in.
@@ -12,7 +12,7 @@ If you accidentally leak your Embassy's addresses, do not worry. You Embassy is
Tor
===
Connecting to your Embassy over :ref:`tor` requires uing a browser that supports *.onion* URLs.
Connecting to your Embassy over :ref:`tor` requires using a browser that supports *.onion* URLs.
Currently, Tor is the default and our recommended approach for most users. It *just works*. The one drawback, however, is latency; onion-routed communications over Tor can be slow. For a lightning fast experience, you can connect to your Embassy over LAN (below), but this requires additional setup.
@@ -31,6 +31,6 @@ Below are a list of our recommended browsers for Tor:
LAN
===
Connecting to your Embassy over :ref:`lan` has the benefit of being fast! It requires uing a browser that supports *.local* URLs, which is true for most browsers.
Connecting to your Embassy over :ref:`lan` has the benefit of being fast! It requires using a browser that supports *.local* URLs, which is true for most browsers.
This option is considered *advanced*, since it requires :ref:`installing and trusting your Embassy's Root Certificate Authority SSL<ssl-setup>` on any phone or laptop you use to connect.

7
source/support/concepts.rst
View File

@@ -4,8 +4,7 @@
Concepts
********
Depending on your background, the Embassy platform may deal with some unfamilar concepts. While it is not strictly *necessary* for you to understand these concepts to use your Embassy, we know many of you would like to.
Depending on your background, the Embassy platform may deal with some unfamiliar concepts. While it is not strictly *necessary* for you to understand these concepts to use your Embassy, we know many of you would like to.
.. _embassyos:
@@ -25,7 +24,7 @@ Embassy OS is a forked branch of the Buster Lite version of Raspberry Pi OS. Sta
* a custom application management layer specialized for installing, running, and backing up .s9pk packaged services
* a layer responsible for Embassy specific operations, such as Tor, Backups, and Notifications
The .s9pk extension is Start9 Labs's custom package format based on tar. It encompasses the necessary components to compress, host, and install a service on the marketplace.
The .s9pk extension is Start9 Labs' custom package format based on tar. It encompasses the necessary components to compress, host, and install a service on the marketplace.
.. _open-source:
@@ -51,7 +50,7 @@ LAN
A Local Area Network (LAN) is a computer network that interconnects computers within a limited area such as a residence, school, laboratory, university campus or office building.
Devices on a LAN are private and protected, such that only devices conncted to the same Ethernet or WiFi network can see or communicate with them.
Devices on a LAN are private and protected, such that only devices connected to the same Ethernet or WiFi network can see or communicate with them.
Your Embassy hosts itself on the LAN and is reachable by visiting its *.local* URL in the browser while also connected to the LAN.

2
source/user-manuals/embassyos/about.rst
View File

@@ -4,4 +4,4 @@ About
``Embassy ---> About``
This page conatins static information about your device, such as its ID, Tor Address, and hardware specs.
This page contains static information about your device, such as its ID, Tor Address, and hardware specs.

2
source/user-manuals/embassyos/developer-options/alt-marketplace.rst
View File

@@ -7,7 +7,7 @@ Alternative Marketplace
Embassy OS supports accessing alternative marketplaces by configuring a system file.
Start9 Labs is not responsible for issues encountered by downloading unverified services from these alternative marketplaces.
After SSHing into the Embassy, run the following commands::
After SSH-ing into the Embassy, run the following commands::
sudo systemctl stop agent
sudo sh -c "echo '<alternative_marketplace_url>' > /root/agent/alt_registry_url.txt"

4
source/user-manuals/embassyos/power.rst
View File

@@ -6,7 +6,7 @@ Restart
=======
#. ``Embassy ---> Restart ---> 'Restart'``.
#. Be patient while services shut down. A *tune* will play, indicating the powerdown is complete.
#. Be patient while services shut down. A *tune* will play, indicating the shutdown is complete.
#. A gentle *bep* will sound when the Embassy is powered back on.
#. A *chime* will sound when the Embassy is ready to use.
@@ -14,7 +14,7 @@ Shutdown
========
#. ``Embassy ---> Shutdown ---> 'Shutdown'``
#. Be patient while services shut down. A *tune* will play, indicating the powerdown is complete.
#. Be patient while services shut down. A *tune* will play, indicating the shutdown is complete.
#. It is now safe to unplug the Embassy from power and the ethernet cable, if connected.
.. note:: After a shutdown, the *only* way to turn your Embassy back on is to unplug it and plug it back in. As such, we do not recommend shutting down your Embassy when you are not physically near it. Instead, you should use the restart option.

4
source/user-manuals/embassyos/updating.rst
View File

@@ -4,7 +4,7 @@ Updating EmbassyOS
``Embassy ---> Check for Updates``
#. If there is an update available, you will be promted to install it.
#. While updating, your Embassy will emit a gantle chime every 20 seconds.
#. If there is an update available, you will be prompted to install it.
#. While updating, your Embassy will emit a gentle chime every 20 seconds.
.. note:: Ensure you have a stable Internet connection, and do not unplug your Embassy during an update. Updates usually complete within a few minutes, but depending on the size of the update and you Internet bandwidth, they can sometimes take up to an hour.

2
source/user-manuals/embassyos/wifi.rst
View File

@@ -15,6 +15,6 @@ WiFi Setup
Add WiFi Network options
#. Save
* Clicking *Add* will save the network credentials but not try to connect immediately. This is useful, for example, if you are conncted over Ethernet at home and want to add your office WiFi credentials.
* Clicking *Add* will save the network credentials but not try to connect immediately. This is useful, for example, if you are connected over Ethernet at home and want to add your office WiFi credentials.
* `Add and Connect`.
#. The saved network will appear in the list when successfully added. If you are successfully connected, the WiFi symbol will be green, at which point, you can safely disconnect the Embassy from your router.

4
source/user-manuals/services/installing.rst
View File

@@ -9,9 +9,9 @@ Adding
To add a new service, find it's listing inside the Service Marketplace: ``Marketplace ---> [Service Name] ---> Install``.
Depending on the size of the service and your Internet connection, installation shoud take between 60 seconds and a few minutes.
Depending on the size of the service and your Internet connection, installation should take between 60 seconds and a few minutes.
After installtion, you can view the service's instructions by navigating to ``Services ---> [Service Name] ---> Instructions``
After installation, you can view the service's instructions by navigating to ``Services ---> [Service Name] ---> Instructions``
.. note:: You can only start and use a service once its dependencies are met, its :ref:`configuration<service-config>` complete, and is in a *running* state.

2
source/user-manuals/services/logs.rst
View File

@@ -4,4 +4,4 @@ Viewing Logs
``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 extremeley 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.

2
source/user-manuals/services/managing-deps.rst
View File

@@ -1,4 +1,4 @@
.. _managing dependencies:
.. _managing-dependencies:
*********************
Managing Dependencies

2
source/user-manuals/services/service-config.rst
View File

@@ -10,4 +10,4 @@ After installation or update, some services require configuration before they ca
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.
Config options are defined by the service developer and can be alomst 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.
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.