From be80a9aeb28f819318aaf9d6f242b2175c973e68 Mon Sep 17 00:00:00 2001 From: Lucy Cifferello Date: Thu, 8 Oct 2020 12:22:27 -0600 Subject: [PATCH] typos and mobile stlying --- source/_static/default.css | 8 +++++++- source/conf.py | 1 + source/getting-started/connecting.rst | 6 +++--- source/support/concepts.rst | 7 +++---- source/user-manuals/embassyos/about.rst | 2 +- .../embassyos/developer-options/alt-marketplace.rst | 2 +- source/user-manuals/embassyos/power.rst | 4 ++-- source/user-manuals/embassyos/updating.rst | 4 ++-- source/user-manuals/embassyos/wifi.rst | 2 +- source/user-manuals/services/installing.rst | 4 ++-- source/user-manuals/services/logs.rst | 2 +- source/user-manuals/services/managing-deps.rst | 2 +- source/user-manuals/services/service-config.rst | 2 +- 13 files changed, 26 insertions(+), 20 deletions(-) diff --git a/source/_static/default.css b/source/_static/default.css index 87e4cfa..ec956b9 100644 --- a/source/_static/default.css +++ b/source/_static/default.css @@ -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; + } } \ No newline at end of file diff --git a/source/conf.py b/source/conf.py index 7c79879..f4eb6e8 100644 --- a/source/conf.py +++ b/source/conf.py @@ -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 = "" diff --git a/source/getting-started/connecting.rst b/source/getting-started/connecting.rst index 274eba3..03d8533 100644 --- a/source/getting-started/connecting.rst +++ b/source/getting-started/connecting.rst @@ -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` on any phone or laptop you use to connect. \ No newline at end of file diff --git a/source/support/concepts.rst b/source/support/concepts.rst index 8557d3b..601aaa2 100644 --- a/source/support/concepts.rst +++ b/source/support/concepts.rst @@ -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. diff --git a/source/user-manuals/embassyos/about.rst b/source/user-manuals/embassyos/about.rst index 177368d..77c623c 100644 --- a/source/user-manuals/embassyos/about.rst +++ b/source/user-manuals/embassyos/about.rst @@ -4,4 +4,4 @@ About ``Embassy ---> About`` -This page conatins static information about your device, such as its ID, Tor Address, and hardware specs. \ No newline at end of file +This page contains static information about your device, such as its ID, Tor Address, and hardware specs. \ No newline at end of file diff --git a/source/user-manuals/embassyos/developer-options/alt-marketplace.rst b/source/user-manuals/embassyos/developer-options/alt-marketplace.rst index 4bb4d8d..80ebe7f 100644 --- a/source/user-manuals/embassyos/developer-options/alt-marketplace.rst +++ b/source/user-manuals/embassyos/developer-options/alt-marketplace.rst @@ -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 '' > /root/agent/alt_registry_url.txt" diff --git a/source/user-manuals/embassyos/power.rst b/source/user-manuals/embassyos/power.rst index b0142d4..1b28d33 100644 --- a/source/user-manuals/embassyos/power.rst +++ b/source/user-manuals/embassyos/power.rst @@ -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. \ No newline at end of file diff --git a/source/user-manuals/embassyos/updating.rst b/source/user-manuals/embassyos/updating.rst index ccce44c..5d088ac 100644 --- a/source/user-manuals/embassyos/updating.rst +++ b/source/user-manuals/embassyos/updating.rst @@ -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. \ No newline at end of file diff --git a/source/user-manuals/embassyos/wifi.rst b/source/user-manuals/embassyos/wifi.rst index d6b3dff..075fce0 100644 --- a/source/user-manuals/embassyos/wifi.rst +++ b/source/user-manuals/embassyos/wifi.rst @@ -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. \ No newline at end of file diff --git a/source/user-manuals/services/installing.rst b/source/user-manuals/services/installing.rst index 2e30592..8c06b12 100644 --- a/source/user-manuals/services/installing.rst +++ b/source/user-manuals/services/installing.rst @@ -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` complete, and is in a *running* state. diff --git a/source/user-manuals/services/logs.rst b/source/user-manuals/services/logs.rst index 60da215..4a6ea82 100644 --- a/source/user-manuals/services/logs.rst +++ b/source/user-manuals/services/logs.rst @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/source/user-manuals/services/managing-deps.rst b/source/user-manuals/services/managing-deps.rst index 8a2ae0e..7eeeb6b 100644 --- a/source/user-manuals/services/managing-deps.rst +++ b/source/user-manuals/services/managing-deps.rst @@ -1,4 +1,4 @@ -.. _managing dependencies: +.. _managing-dependencies: ********************* Managing Dependencies diff --git a/source/user-manuals/services/service-config.rst b/source/user-manuals/services/service-config.rst index a2e7910..12dae9c 100644 --- a/source/user-manuals/services/service-config.rst +++ b/source/user-manuals/services/service-config.rst @@ -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. \ No newline at end of file +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. \ No newline at end of file