From a8e436101c82eccb5456d147569c8fae144e290c Mon Sep 17 00:00:00 2001
From: Eliot Berriot <contact@eliotberriot.com>
Date: Mon, 7 May 2018 00:17:42 +0200
Subject: [PATCH] Fix #132: better upgrading instructions for frontend files on
docker
---
changes/changelog.d/132.doc | 1 +
docs/installation/index.rst | 6 +++++
docs/upgrading.rst | 49 ++++++++++++++++++++-----------------
3 files changed, 33 insertions(+), 23 deletions(-)
create mode 100644 changes/changelog.d/132.doc
diff --git a/changes/changelog.d/132.doc b/changes/changelog.d/132.doc
new file mode 100644
index 0000000000..029554739a
--- /dev/null
+++ b/changes/changelog.d/132.doc
@@ -0,0 +1 @@
+Up-to-date documentation for upgrading front-end files on docker setup (#132)
diff --git a/docs/installation/index.rst b/docs/installation/index.rst
index 76ee9a892b..ae5794b6cf 100644
--- a/docs/installation/index.rst
+++ b/docs/installation/index.rst
@@ -74,6 +74,12 @@ We also maintain an installation guide for Debian 9.
Frontend setup
---------------
+.. note::
+
+ You do not need to do this if you are deploying using Docker, as frontend files
+ are already included in the docker image.
+
+
Files for the web frontend are purely static and can simply be downloaded, unzipped and served from any webserver:
.. parsed-literal::
diff --git a/docs/upgrading.rst b/docs/upgrading.rst
index 674878ba7c..bd3d5578f3 100644
--- a/docs/upgrading.rst
+++ b/docs/upgrading.rst
@@ -17,29 +17,9 @@ Please take a few minutes to read the :doc:`changelog`: updates should work
similarly from version to version, but some of them may require additional steps.
Those steps would be described in the version release notes.
-Upgrade the static files
-------------------------
-
-Regardless of your deployment choice (docker/non-docker) the front-end app
-is updated separately from the API. This is as simple as downloading
-the zip with the static files and extracting it in the correct place.
-
-The following example assume your setup match :ref:`frontend-setup`.
-
-.. parsed-literal::
-
- # this assumes you want to upgrade to version "|version|"
- export FUNKWHALE_VERSION="|version|"
- cd /srv/funkwhale
- curl -L -o front.zip "https://code.eliotberriot.com/funkwhale/funkwhale/builds/artifacts/$FUNKWHALE_VERSION/download?job=build_front"
- unzip -o front.zip
- rm front.zip
-
-Upgrading the API
------------------
Docker setup
-^^^^^^^^^^^^
+------------
If you've followed the setup instructions in :doc:`Docker`, upgrade path is
easy:
@@ -57,10 +37,33 @@ easy:
# Relaunch the containers
docker-compose up -d
+
+
Non-docker setup
-^^^^^^^^^^^^^^^^
+----------------
+
+Upgrade the static files
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+On non-docker setups, the front-end app
+is updated separately from the API. This is as simple as downloading
+the zip with the static files and extracting it in the correct place.
+
+The following example assume your setup match :ref:`frontend-setup`.
+
+.. parsed-literal::
+
+ # this assumes you want to upgrade to version "|version|"
+ export FUNKWHALE_VERSION="|version|"
+ cd /srv/funkwhale
+ curl -L -o front.zip "https://code.eliotberriot.com/funkwhale/funkwhale/builds/artifacts/$FUNKWHALE_VERSION/download?job=build_front"
+ unzip -o front.zip
+ rm front.zip
+
+Upgrading the API
+^^^^^^^^^^^^^^^^^
-On non docker-setup, upgrade involves a few more commands. We assume your setup
+On non-docker, upgrade involves a few more commands. We assume your setup
match what is described in :doc:`debian`:
.. parsed-literal::
--
GitLab