cleanup

piku · Apr 7, 2024 · 9522f0c · 9522f0c
1 parent 456c502
commit 9522f0c
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 71 deletions.
diff --git a/docs/install/INSTALL-centos-9.md b/docs/install/INSTALL-centos-9.md
@@ -1,6 +1,7 @@
 # Installation on CentOS 9
 
-> This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
+!!! note
+    This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
 
 All steps done as root (or add sudo if you prefer).
 

diff --git a/docs/install/INSTALL-other.md b/docs/install/INSTALL-other.md
@@ -1,7 +1,7 @@
 # Installation on other platforms
 
-> This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
-
+!!! note
+    This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
 
 ## Dependencies
 

diff --git a/docs/install/INSTALL-raspbian-9.4-stretch-10-buster.md b/docs/install/INSTALL-raspbian-9.4-stretch-10-buster.md
@@ -1,6 +1,7 @@
 # Installation on Raspbian Stretch or Buster
 
-> This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
+!!! note
+    This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
 
 `piku` setup is simplified in modern Debian versions, since it can take advantage of some packaging improvements in [uWSGI][uwsgi] and does not require a custom `systemd` service. However, Stretch still ships with Python 3.5, which means it's not an ideal environment for new deployments on both Intel and ARM devices (Buster, in turn, ships with Python 3.7).
 

diff --git a/docs/old/SCRIPTS.md → docs/install/INSTALL-ubuntu-16.04.md b/docs/old/SCRIPTS.md → docs/install/INSTALL-ubuntu-16.04.md
diff --git a/docs/install/INSTALL-ubuntu-18.04-bionic.md b/docs/install/INSTALL-ubuntu-18.04-bionic.md
@@ -1,6 +1,7 @@
 # Installation on Ubuntu 18.04 LTS (Bionic)
 
-> This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
+!!! Note
+    This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
 
 `piku` setup is simplified in Bionic, since it can take advantage of some packaging improvements in [uWSGI][uwsgi] and does not require a custom `systemd` service. Since Bionic also ships with Python 3.6, this is an ideal environment for new deployments on both Intel and ARM devices.
 

diff --git a/docs/install/INSTALL-ubuntu-22.04-jammy.md b/docs/install/INSTALL-ubuntu-22.04-jammy.md
@@ -1,6 +1,7 @@
 # Installation on Ubuntu 22.04 LTS (Jammy)
 
-> This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
+!!! Note
+    This is a standalone, distribution-specific version of `INSTALL.md`. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)
 
 `piku` setup is simplified in Jammy, since it can take advantage of some packaging improvements in [uWSGI][uwsgi] and does not require a custom `systemd` service. Since Jammy also ships with Python 3.10, this is an ideal environment for new deployments on both Intel and ARM devices.
 

diff --git a/docs/old/RASPBERRY_PI_QUICKSTART.md → docs/install/RASPBERRY_PI_QUICKSTART.md b/docs/old/RASPBERRY_PI_QUICKSTART.md → docs/install/RASPBERRY_PI_QUICKSTART.md
@@ -1,8 +1,7 @@
 # Setting up a Raspberry Pi Piku Server from Scratch
 
-## DISCLAIMER!
-
-### These instructions are correct as of April 1st 2016
+!!! Warning
+    These instructions are correct as of April 1st 2016. Quite a bit has changed since then in Raspberry Pi land, so you may need to adjust them accordingly.
 
 Start by flashing a SD card with [the latest Raspbian Jessie Lite image](https://www.raspberrypi.org/downloads/raspbian/).
 
@@ -52,8 +51,7 @@ sudo apt install -y python-virtualenv python-pip git uwsgi uwsgi-plugin-python n
 sudo pip install -U click
 sudo reboot
 ```
-
-# Meanwhile, go get the goodies while Raspberry Pi is rebooting
+ Meanwhile, go get the goodies while Raspberry Pi is rebooting
 
 (We assume you know about ssh keys and have one "at hand", you'll need to copy it)
 
@@ -116,9 +114,9 @@ Prepare uWSGI (part two):
 sudo systemctl start uwsgi-piku
 sudo systemctl status uwsgi-piku.service
 ```
+If you're still here, odds are your Pi is ready for work
 
-
-# If you're still here, odds are your Pi is ready for work
+### Testing
 
 Go back to your machine and try these commands:
 

diff --git a/docs/old/ROADMAP.md b/docs/old/ROADMAP.md