From ddadfc98b3493f69e06ef9ad3829225627f3b51b Mon Sep 17 00:00:00 2001 From: Ciaran Ainsworth Date: Sat, 2 Apr 2022 14:17:43 +0200 Subject: [PATCH] Add redirects and third-party list --- changes/changelog.d/install-guides.enhancement | 1 + .../installation_docs/index.md | 3 +-- .../installation_docs/third_party.md | 10 ++++++++++ docs/conf.py | 4 ++++ 4 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 changes/changelog.d/install-guides.enhancement create mode 100644 docs/administrator_documentation/installation_docs/third_party.md diff --git a/changes/changelog.d/install-guides.enhancement b/changes/changelog.d/install-guides.enhancement new file mode 100644 index 000000000..75287d06f --- /dev/null +++ b/changes/changelog.d/install-guides.enhancement @@ -0,0 +1 @@ +Updated the installation guides to make installation steps clearer. \ No newline at end of file diff --git a/docs/administrator_documentation/installation_docs/index.md b/docs/administrator_documentation/installation_docs/index.md index 3cd906433..511dc64a2 100644 --- a/docs/administrator_documentation/installation_docs/index.md +++ b/docs/administrator_documentation/installation_docs/index.md @@ -2,8 +2,6 @@ Choose your installation method and follow the guides to set up your pod. -## Requirements - Funkwhale requires the following: - __A dedicated domain or subdomain__ – you can't run Funkwhale in a subdirectory of a domain. You need to run it on a domain or a subdomain. For example: `https://mypod.io` or `https://funkwhale.mysite.io`. @@ -18,5 +16,6 @@ maxdepth: 1 quick_install docker debian +third_party ``` diff --git a/docs/administrator_documentation/installation_docs/third_party.md b/docs/administrator_documentation/installation_docs/third_party.md new file mode 100644 index 000000000..45c50fe4a --- /dev/null +++ b/docs/administrator_documentation/installation_docs/third_party.md @@ -0,0 +1,10 @@ +# Third-party installation methods + +These installation methods are not provided by the Funkwhale project. If you have any issues with your installation, please contact the installation maintainers. + +- [YunoHost](https://github.com/YunoHost-Apps/funkwhale_ynh) +- [Arch Linux](https://wiki.archlinux.org/index.php/Funkwhale) +- [NixOS](https://github.com/mmai/funkwhale-nixos) +- [Kubernetes helm chart](https://gitlab.com/ananace/charts/) +- [HomelabOS](https://homelabos.com/docs/software/funkwhale/) +- [Docker swarm](https://github.com/fedeb95/funkwhale-swarm) diff --git a/docs/conf.py b/docs/conf.py index 468449c26..c67a93766 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -233,6 +233,10 @@ redirect_files = [ ("moderator/domains.html", "../moderator_documentation/domains/index.html"), ("moderator/users.html", "../moderator_documentation/users/index.html"), ("moderator/listing.html", "../moderator_documentation/allow_listing/index.html"), + ("installation/index.html", "../administrator_documentation/installation_docs/index.html"), + ("installation/index.html#quick-install", "../administrator_documentation/installation_docs/quick_install.html"), + ("installation/docker.html", "../administrator_documentation/installation_docs/docker.html"), + ("installation/debian.html", "../administrator_documentation/installation_docs/debian.html"), ] # Generate redirect template