From f4b7dd651873827a83d83350736ae1578f51c5a5 Mon Sep 17 00:00:00 2001
From: Eliot Berriot <contact@eliotberriot.com>
Date: Wed, 19 Dec 2018 10:21:27 +0100
Subject: [PATCH] Fix #642: Deploy documentation from the master branch instead
of the develop branch to avoid inconsistencies
---
.gitlab-ci.yml | 2 +-
changes/changelog.d/642.documentation | 1 +
docs/installation/debian.rst | 2 +-
docs/installation/docker.rst | 8 ++++----
docs/installation/index.rst | 8 ++++----
5 files changed, 11 insertions(+), 10 deletions(-)
create mode 100644 changes/changelog.d/642.documentation
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 213c63ce..e930ccc7 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -230,7 +230,7 @@ pages:
paths:
- public
only:
- - develop@funkwhale/funkwhale
+ - master@funkwhale/funkwhale
tags:
- docker
diff --git a/changes/changelog.d/642.documentation b/changes/changelog.d/642.documentation
new file mode 100644
index 00000000..e93dca7b
--- /dev/null
+++ b/changes/changelog.d/642.documentation
@@ -0,0 +1 @@
+Deploy documentation from the master branch instead of the develop branch to avoid inconsistencies (#642)
diff --git a/docs/installation/debian.rst b/docs/installation/debian.rst
index 77efda72..369cc676 100644
--- a/docs/installation/debian.rst
+++ b/docs/installation/debian.rst
@@ -211,7 +211,7 @@ Download the sample environment file:
.. parsed-literal::
- curl -L -o config/.env "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/env.prod.sample"
+ curl -L -o config/.env "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/env.prod.sample"
# symlink it so it's sourced automatically by the API process
# (This won't be needed anymore once release 0.18 is out)
ln -s /srv/funkwhale/config/.env /srv/funkwhale/api/.env
diff --git a/docs/installation/docker.rst b/docs/installation/docker.rst
index 255d2d32..13403574 100644
--- a/docs/installation/docker.rst
+++ b/docs/installation/docker.rst
@@ -12,9 +12,9 @@ Download the sample docker-compose file:
mkdir /srv/funkwhale
cd /srv/funkwhale
mkdir nginx
- curl -L -o nginx/funkwhale.template "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/docker.nginx.template"
- curl -L -o nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/funkwhale_proxy.conf"
- curl -L -o docker-compose.yml "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/docker-compose.yml"
+ curl -L -o nginx/funkwhale.template "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/docker.nginx.template"
+ curl -L -o nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/funkwhale_proxy.conf"
+ curl -L -o docker-compose.yml "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/docker-compose.yml"
At this point, the archticture of ``/srv/funkwhale`` should look like that:
@@ -32,7 +32,7 @@ Create your env file:
.. parsed-literal::
export FUNKWHALE_VERSION="|version|"
- curl -L -o .env "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/env.prod.sample"
+ curl -L -o .env "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/env.prod.sample"
sed -i "s/FUNKWHALE_VERSION=latest/FUNKWHALE_VERSION=$FUNKWHALE_VERSION/" .env
sudo nano .env
diff --git a/docs/installation/index.rst b/docs/installation/index.rst
index 7df753b9..0d5412a2 100644
--- a/docs/installation/index.rst
+++ b/docs/installation/index.rst
@@ -148,8 +148,8 @@ On docker deployments, run the following commands:
.. code:: shell
# download the needed files
- curl -L -o /etc/nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/funkwhale_proxy.conf"
- curl -L -o /etc/nginx/sites-available/funkwhale.template "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/docker.proxy.template"
+ curl -L -o /etc/nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/funkwhale_proxy.conf"
+ curl -L -o /etc/nginx/sites-available/funkwhale.template "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/docker.proxy.template"
# create a final nginx configuration using the template based on your environment
set -a && source /srv/funkwhale/.env && set +a
@@ -164,8 +164,8 @@ On non-docker deployments, run the following commands:
.. code:: shell
# download the needed files
- curl -L -o /etc/nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/funkwhale_proxy.conf"
- curl -L -o /etc/nginx/sites-available/funkwhale.template "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/nginx.template"
+ curl -L -o /etc/nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/funkwhale_proxy.conf"
+ curl -L -o /etc/nginx/sites-available/funkwhale.template "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/nginx.template"
# create a final nginx configuration using the template based on your environment
set -a && source /srv/funkwhale/config/.env && set +a
--
GitLab