From d7bfe3305b68453d9742aeadac1cfa89d1f79123 Mon Sep 17 00:00:00 2001 From: Sean King Date: Sun, 30 Aug 2020 13:43:40 -0600 Subject: [PATCH] Fix administration and development docs --- .../administration/administration/removing.md | 10 ------ .../administration/administration/updating.md | 36 ------------------- docs/administration/updating.md | 13 ++++--- .../development/how-it-works.md | 0 .../development/live-backend.md | 0 .../development/local-config.md | 0 .../development/running-locally.md | 0 .../development/yarn-commands.md | 0 8 files changed, 6 insertions(+), 53 deletions(-) delete mode 100644 docs/administration/administration/removing.md delete mode 100644 docs/administration/administration/updating.md rename docs/{administration => }/development/how-it-works.md (100%) rename docs/{administration => }/development/live-backend.md (100%) rename docs/{administration => }/development/local-config.md (100%) rename docs/{administration => }/development/running-locally.md (100%) rename docs/{administration => }/development/yarn-commands.md (100%) diff --git a/docs/administration/administration/removing.md b/docs/administration/administration/removing.md deleted file mode 100644 index a161114e3..000000000 --- a/docs/administration/administration/removing.md +++ /dev/null @@ -1,10 +0,0 @@ -# Removing Soapbox - -Removing Soapbox FE and reverting to Pleroma FE is really easy. Just run the following: -``` -rm /opt/pleroma/instance/static/index.html -rm -R /opt/pleroma/instance/static/packs -rm -R /opt/pleroma/instance/static/sounds -``` - -If you need to remove other stuff, feel free to do so. But be careful not to remove your own HTML files. diff --git a/docs/administration/administration/updating.md b/docs/administration/administration/updating.md deleted file mode 100644 index 6b173c8cd..000000000 --- a/docs/administration/administration/updating.md +++ /dev/null @@ -1,36 +0,0 @@ -# Updating Soapbox - -You should always check the [release notes/changelog](https://gitlab.com/soapbox-pub/soapbox-fe/-/blob/develop/CHANGELOG.md) in case there are deprecations, special update changes, etc. - -Besides that, it's relatively pretty easy to update Soapbox FE. There's two ways to go about it: with the command line or with an unofficial script. - -## Updating with the command line - -To update Soapbox FE via the command line, do the following: - -``` -# Download the build. -curl -L https://gitlab.com/soapbox-pub/soapbox-fe/-/jobs/artifacts/v(latest.version.here)/download?job=build-production -o soapbox-fe.zip - -# Remove all the current Soapbox FE build in Pleroma's instance directory. -rm -R /opt/pleroma/instance/static/packs -rm /opt/pleroma/instance/static/index.html -rm -R /opt/pleroma/instance/static/sounds - -# Unzip the new build to Pleroma's instance directory. -busybox unzip soapbox-fe.zip -o -d /opt/pleroma/instance -``` - -## Updating with an unofficial script - -You can also update Soapbox using [Sandia Mesa's updater bash script for Soapbox FE](https://code.sandiamesa.com/traboone/soapbox-update). - -First, download the updater script if you haven't yet: ``sudo -Hu pleroma wget -P /var/lib/pleroma https://code.sandiamesa.com/traboone/soapbox-update/raw/branch/master/soapbox-update.sh -N`` - -Then, set the permissions of the updater script so that it can be executed: ``chmod u+x /var/lib/pleroma/soapbox-update.sh`` - -Finally, go to the Pleroma user's directory ``cd /var/lib/pleroma`` and then run ``sudo -Hu pleroma ./soapbox-update.sh``. - -## After updating Soapbox - -The changes take effect immediately, just refresh your browser tab. It's not necessary to restart the Pleroma service. diff --git a/docs/administration/updating.md b/docs/administration/updating.md index bbda31341..6b173c8cd 100644 --- a/docs/administration/updating.md +++ b/docs/administration/updating.md @@ -10,13 +10,12 @@ To update Soapbox FE via the command line, do the following: ``` # Download the build. - curl -L https://gitlab.com/soapbox-pub/soapbox-fe/-/jobs/artifacts/v(latest.version.here)/download?job=build-production -o soapbox-fe.zip # Remove all the current Soapbox FE build in Pleroma's instance directory. -sudo rm -R /opt/pleroma/instance/static/packs -sudo rm /opt/pleroma/instance/static/index.html -sudo rm -R /opt/pleroma/instance/static/sounds +rm -R /opt/pleroma/instance/static/packs +rm /opt/pleroma/instance/static/index.html +rm -R /opt/pleroma/instance/static/sounds # Unzip the new build to Pleroma's instance directory. busybox unzip soapbox-fe.zip -o -d /opt/pleroma/instance @@ -26,11 +25,11 @@ busybox unzip soapbox-fe.zip -o -d /opt/pleroma/instance You can also update Soapbox using [Sandia Mesa's updater bash script for Soapbox FE](https://code.sandiamesa.com/traboone/soapbox-update). -First, download the updater script if you haven't yet: ``curl -O https://code.sandiamesa.com/traboone/soapbox-update/raw/branch/master/soapbox-update.sh`` +First, download the updater script if you haven't yet: ``sudo -Hu pleroma wget -P /var/lib/pleroma https://code.sandiamesa.com/traboone/soapbox-update/raw/branch/master/soapbox-update.sh -N`` -Then, set the permissions of the updater script so that it can be executed: ``chmod u+x soapbox-update.sh`` +Then, set the permissions of the updater script so that it can be executed: ``chmod u+x /var/lib/pleroma/soapbox-update.sh`` -Finally, run ``sudo ./soapbox-update.sh``. +Finally, go to the Pleroma user's directory ``cd /var/lib/pleroma`` and then run ``sudo -Hu pleroma ./soapbox-update.sh``. ## After updating Soapbox diff --git a/docs/administration/development/how-it-works.md b/docs/development/how-it-works.md similarity index 100% rename from docs/administration/development/how-it-works.md rename to docs/development/how-it-works.md diff --git a/docs/administration/development/live-backend.md b/docs/development/live-backend.md similarity index 100% rename from docs/administration/development/live-backend.md rename to docs/development/live-backend.md diff --git a/docs/administration/development/local-config.md b/docs/development/local-config.md similarity index 100% rename from docs/administration/development/local-config.md rename to docs/development/local-config.md diff --git a/docs/administration/development/running-locally.md b/docs/development/running-locally.md similarity index 100% rename from docs/administration/development/running-locally.md rename to docs/development/running-locally.md diff --git a/docs/administration/development/yarn-commands.md b/docs/development/yarn-commands.md similarity index 100% rename from docs/administration/development/yarn-commands.md rename to docs/development/yarn-commands.md