Merge remote-tracking branch 'upstream/master'

README.md

@@ -15,12 +15,14 @@ The Lollipop Cloud project is a way to self-host internet services, such as a we
     - We have generated Armbian builds specifically for the Lollipop's supported boards. You can [download Armbian builds for Lollipops here (link)](https://dl.lollipopcloud.solutions/files/armbian).
     - **Note about the Raspberry Pi:** The [Raspberry Pi 3 (link)](https://www.raspberrypi.org/documentation/hardware/raspberrypi/README.md) with the BCM2837 processor, at least 512MB RAM, and Raspbian may work well as a Lollipop; however, we have not tested this configuration at this time.
 - A means to interact with the SBC (monitor/keyboard, serial adapter, or ssh via ethernet).
-- A wifi adapter, USB cellular modem (3G/4G/WCDMA/LTE), [GPS module (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware/gps.md), [RTC (Real Time Clock) (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware/rtc.md), [Bluetooth Serial Terminal (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware/bluetooth_terminal.md), other hardware you need for your custom setup. See also: [Hardware Considerations (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware_notes.md).
+- A wifi adapter (or two), USB cellular modem (3G/4G/WCDMA/LTE), [GPS module (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware/gps.md), [RTC (Real Time Clock) (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware/rtc.md), [Bluetooth Serial Terminal (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware/bluetooth_terminal.md), other hardware you need for your custom setup. See also: [Hardware Considerations (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware_notes.md).
 
 ## Initial Setup
+
 [Setup For Beginners (link)](for-beginners.md): If you are new to installing Linux, or would like a little extra help walking through the initial creation of your Lollipop, please take a look our documentation written especially for beginners. Then skip down to the next section ([Networking](#Networking)) when you're ready.
 
 If you're not using the [link for beginners](for-beginners.md), the following links are good first steps:
+- Mirror this documentation locally with `git clone https://git.lollipopcloud.solutions/lollipop-cloud/docs.git /path/to/docs`
 - [Download Armbian (link)](https://dl.lollipopcloud.solutions/files/armbian)
 - [First Boot (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/first_boot.md)
 - [Base Setup (link)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/base_setup.md)

armbian/armbianmonitor.md

@@ -0,0 +1,37 @@
+# ArmbianMonitor
+
+A quick and easy way to monitor CPU temperatures. If you need or want something more comprehensive, try [Munin](monitoring.md).
+
+You should not need to monitor your Lollipop's temperatures during ordinary use. However, if your device is operating in extreme conditions (very hot or cold weather, or in a small space without ventilation) and is behaving oddly, you may find these statistics helpful.
+
+Optimal operating temperatures vary by board and CPU (central processing unit), with heat tending to cause more problems than cold. If your CPU is painful to touch, you may want to consider adding a heat sink and/or fan.
+
+## To Install
+
+`apt upgrade`
+`apt install armbianmonitor`
+
+## To Monitor
+
+At the command prompt: `sudo armbianmonitor -m` for ongoing, real-time temperature readings. (When you've seen enough, enter `ctrl + C` to quit.)
+
+### Typical Output
+
+```
+21:41:38: 1296MHz  0.15   2%   0%   0%   0%   0%   0% 57.5°C  0/9
+21:41:43:  480MHz  0.14   1%   0%   0%   0%   0%   0% 55.7°C  0/9
+21:41:49:  480MHz  0.13   2%   1%   0%   0%   0%   0% 56.7°C  0/9
+21:41:54:  480MHz  0.12   2%   1%   0%   0%   0%   0% 55.2°C  0/9
+21:41:59:  480MHz  0.11   2%   1%   0%   0%   0%   0% 56.4°C  0/9
+21:42:04:  480MHz  0.10   5%   2%   2%   0%   0%   0% 54.8°C  0/9
+21:42:09: 1296MHz  0.09   2%   1%   0%   0%   0%   0% 55.4°C  0/9
+21:42:14:  480MHz  0.08   2%   1%   0%   0%   0%   0% 56.0°C  0/9
+21:42:20: 1296MHz  0.08   2%   1%   0%   0%   0%   0% 55.3°C  0/9
+21:42:25:  480MHz  0.07   1%   0%   0%   0%   0%   0% 55.2°C  0/9^C
+```
+
+## For More Information
+
+- `sudo armbianmonitor` will provide a list of other monitoring features and options.
+- source: https://forum.armbian.com/topic/904-how-to-check-temperature-of-orangepi-pc/
+- [Raspberry Pi works well when submerged in liquid nitrogen](https://www.geek.com/chips/raspberry-pi-proven-to-be-stable-when-submerged-in-liquid-nitrogen-1555235/)

armbian/first_boot.md

@@ -12,7 +12,7 @@ The rest of this guide assumes you'll be logged in as the admin user and will be
 
 ## Mirror Docs
 
-Just in case you need reference material while offline or on a bad network link, mirror these docs to the root filesystem.
+Just in case you need reference material while offline or on a bad network link, mirror these docs to the root file system.
 
 ```git clone https://git.lollipopcloud.solutions/lollipop-cloud/docs.git /root/docs```
 

armbian/monitoring.md

@@ -2,7 +2,7 @@
 
 Track resource utilization over time.
 
-**BE MINDFUL OF RUNNING THIS. IT CAN CAUSE PROBLEMS WITH DISK IOPS AND RAM USAGE. BEST ONLY USED IF NEEDED OR YOU'RE TROUBLESHOOTING.**
+**BE MINDFUL OF RUNNING THIS. IT CAN CAUSE PROBLEMS WITH DISK IOPS AND RAM USAGE. BEST ONLY USED IF NEEDED OR YOU'RE TROUBLESHOOTING. If you would like to monitor CPU temperatures, we recommend installing [ArmbianMonitor](armbianmonitor.md).**
 
 ## cadvisor
 

armbian/network_manager.md

@@ -141,7 +141,7 @@ Run ```nmcli connection del [UUID]``` for each UUID listed in the previous comma
 
 ### WiFi 2.4ghz Access Point
 
-This setup will configure the Lollipop's internal WiFi adapter as an access point. NetworkManager assumes you'll have only *one* Access Point active per device at a time. If you'd prefer your wireless access point use 5ghz, skip this step.
+This setup will configure the Lollipop's internal WiFi adapter as an access point. NetworkManager assumes you'll have only *one* Access Point active per device at a time. If you'd prefer your wireless access point use 5ghz AND your hardware is capable of 5ghz, skip this step. *Example: the OrangePi PC Plus must be configured as a 2.4ghz access point, unless you are configuring an upgraded or external adapter capable of 5ghz.*
 
 2.4ghz is a good choice and a default for most commerical access points for compatibility with WiFi clients. This is recommended if you're not sure.
 

contributing/CONTRIBUTING.md

@@ -16,3 +16,19 @@ If you already have code or documentation to contribute, our [documentation repo
 Lowering the barrier for contributions is important: we value your input, regardless of your level of experience or area of expertise. If you would rather [contact us directly (link)](https://lollipopcloud.solutions/page/contact/), please do not hesitate to reach out through email or chat. We can also provide assistance walking you through our contribution process if you'd like to learn SOSASA or Gitea.
 
 Note: by submitting a PR, you agree to your contribution(s) being licensed as described in our [LICENSE.md (link)](LICENSE.md).
+
+## Documentation
+
+**In order to ease up the process of reading and applying docs, please:**
+
+*   Add an intro to what the documentation is about (a couple of paragraphs should suffice) before presenting links, code, etc., for the sake of context - especially to the non-initiated;
+*   Make very clear what each step is and use language that anyone would understand (KISS);
+*   Don't abbreviate or assume something is banal/easy/common knowledge;
+*   Be specific even when it sounds like it's something everyone knows about.
+    Example of something that should be specified in docs: where to implement the stuff you just wrote about;
+
+**For extra readability purposes:**
+
+*   Use markdown, if possible, for different areas/topics among the doc (text vs code, for example), as well as space;
+*   Break apart config/commands from docs.
+*   If you can't explain a "basic concept" in a easy way without making a wall of text in the middle of your doc, feel free to hyperlink to other documentation where those concepts are already explained, be it Wikipedia or another doc online that has high readability and reliability;

for-beginners/for-beginners.md

@@ -5,11 +5,16 @@ The Lollipop is a [single-board computer (SBC) (link)](https://en.wikipedia.org/
 # Getting Started
 You will need a single-board computer (SBC) like an [Orange Pi (link)](http://www.orangepi.org/).
 
-For the basic start up and set up of your Orange Pi, you will need either (a) a keyboard and a way to view the display (either an HDMI cable OR a [serial console](https://www.pine64.org/?product=padi-serial-console)), OR (b) an ethernet connection.
+For the basic start up and set up of your Orange Pi, you will need one of the following configurations:
+
+- a keyboard and a way to view the display (either an HDMI cable with a monitor OR a [serial console](https://www.pine64.org/?product=padi-serial-console))
+- an ethernet connection by connecting your SBC to your home router with an ethernet cord (or "patch cable")
+
+__NOTE:__ If you are going to use your SBC wirelessly as a server and a client (example: your laptop will access the internet via your Lollipop, where your Lollipop is connected to a coffee shop's public wifi), you are going to need TWO wifi adapters. If you're using the OrangePi PC Plus, it has its own onboard wifi, but you will need to add a second wifi adapter that uses a USB port, such as this [OurLink Wifi USB Dongle](https://ourlink.us/collections/some/products/glam-hobby-600mbps-ac600-dual-band-usb-wifi-dongle-wireless-network-adapter-for-laptop-desktop-computer-backward-compatible-with-802-11-a-b-g-n-products-2-4-ghz-150mbps-5ghz-433mbps).
 
 You will also need an SD card formatted with Armbian installed.
 
-## Installing Armbian onto an SD card
+## Installing Armbian on an SD card
 [Armbian](https://www.armbian.com/) is a Linux operating system based on Debian and Ubuntu, specifically designed for [ARM boards (link)](https://en.wikipedia.org/wiki/ARM_architecture).
 
 __NOTE:__ Raspberry Pi 3 users will need to use [Raspbian (link)](https://www.raspberrypi.org/downloads/raspbian/) instead of Armbian.
@@ -102,6 +107,10 @@ Now restart the service with `systemctl restart sshd`.
 
 Now you're ready to head back to the [README (link)](docs/README.md) and get started on the networking section.
 
-**Closing suggestion:** It is highly recommended that once you set up networking on your new Lollipop Cloud, that you follow the README's suggestion to install Cockpit. After you install Cockpit, you will be able to configure the rest of your desired Lollipop Cloud features through a web browser on your development (or home) computer.
+**Closing suggestions:**
+
+- It is highly recommended that once you set up networking on your new Lollipop Cloud, that you follow the README's suggestion to install Cockpit. After you install Cockpit, you will be able to configure the rest of your desired Lollipop Cloud features through a web browser on your development (or home) computer.
+
+- Just in case you need all of our documentation while offline or on a bad network connection, mirror these docs to an internet-connected computer by entering the following at the command line: ```git clone https://git.lollipopcloud.solutions/lollipop-cloud/docs.git /root/docs``` where ```/root/docs``` is where you want these documents to live.
 
 _Check and contribute to [the issue tracker (link)](https://kanban.lollipopcloud.solutions/project/admin-lollipop-documentation/kanban) for errors, typos, clarifications, and omissions to improve this documentation. Thanks!_