From dc76d158e7a20b1ced0cdde2c5cc83c83ff9d7b9 Mon Sep 17 00:00:00 2001 From: Tilman Vatteroth Date: Tue, 2 Feb 2021 19:35:10 +0100 Subject: [PATCH] [Docs] Extend setup page with community methods Signed-off-by: Tilman Vatteroth --- .../content/{setup => guides}/reverse-proxy.md | 0 docs/content/setup/arch-linux.md | 5 +++++ docs/content/setup/index.md | 8 -------- docs/content/setup/kubernetes-helm.md | 7 +++++++ docs/content/setup/kubernetes.md | 5 ----- docs/mkdocs.yml | 18 +++++++++++------- 6 files changed, 23 insertions(+), 20 deletions(-) rename docs/content/{setup => guides}/reverse-proxy.md (100%) create mode 100644 docs/content/setup/arch-linux.md delete mode 100644 docs/content/setup/index.md create mode 100644 docs/content/setup/kubernetes-helm.md delete mode 100644 docs/content/setup/kubernetes.md diff --git a/docs/content/setup/reverse-proxy.md b/docs/content/guides/reverse-proxy.md similarity index 100% rename from docs/content/setup/reverse-proxy.md rename to docs/content/guides/reverse-proxy.md diff --git a/docs/content/setup/arch-linux.md b/docs/content/setup/arch-linux.md new file mode 100644 index 000000000..1ffcabf21 --- /dev/null +++ b/docs/content/setup/arch-linux.md @@ -0,0 +1,5 @@ +# Arch Linux + +HedgeDoc is available in the Arch Linux _community_ repository. + +[Link to the package](https://archlinux.org/packages/community/any/hedgedoc/) diff --git a/docs/content/setup/index.md b/docs/content/setup/index.md deleted file mode 100644 index 253450b7d..000000000 --- a/docs/content/setup/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Installation / Upgrading -You can run HedgeDoc in a number of ways: - -- [Docker](docker) -- [Cloudron](cloudron) -- [LinuxServer.io (multi-arch docker)](docker-linuxserver) -- [Heroku](heroku) -- [Manual setup](manual-setup) diff --git a/docs/content/setup/kubernetes-helm.md b/docs/content/setup/kubernetes-helm.md new file mode 100644 index 000000000..67a27e822 --- /dev/null +++ b/docs/content/setup/kubernetes-helm.md @@ -0,0 +1,7 @@ +# Helm Chart + +You can deploy HedgeDoc on your Kubernetes cluster using `helm`. + +[HedgeDoc Helm Chart by nicholaswilde on Artifact Hub](https://artifacthub.io/packages/helm/nicholaswilde/hedgedoc) + +[Source Code](https://nicholaswilde.github.io/helm-charts/) diff --git a/docs/content/setup/kubernetes.md b/docs/content/setup/kubernetes.md deleted file mode 100644 index 7ece0d205..000000000 --- a/docs/content/setup/kubernetes.md +++ /dev/null @@ -1,5 +0,0 @@ -# Kubernetes - -HedgeDoc currently does not support any deployment via Kubernetes. - -If you want to help us creating a helm chart, then feel free to contact us on [Matrix](https://chat.hedgedoc.org/) or [Discourse](https://community.hedgedoc.org/). diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index dcdd531ad..6179bd688 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -8,14 +8,18 @@ edit_uri: https://github.com/hedgedoc/hedgedoc/edit/master/docs/content/ nav: - Home: index.md - Installation: - - 'Manual Installation': setup/manual-setup.md - - 'Reverse Proxy': setup/reverse-proxy.md - - Docker: setup/docker.md - - Cloudron: setup/cloudron.md - - Heroku: setup/heroku.md - - LinuxServer: setup/docker-linuxserver.md - - Yunohost: setup/yunohost.md + - Official installation methods: + - 'Docker Image': setup/docker.md + - 'Manual Installation': setup/manual-setup.md + - Heroku: setup/heroku.md + - Community installation methods: + - 'LinuxServer Docker Image': setup/docker-linuxserver.md + - 'Helm Chart': setup/kubernetes-helm.md + - 'YunoHost App': setup/yunohost.md + - 'Cloudron App': setup/cloudron.md + - 'Arch Linux Package': setup/arch-linux.md - Guides: + - 'Reverse Proxy': guides/reverse-proxy.md - Authentication: - LDAP: guides/auth/ldap-ad.md - OAuth: guides/auth/oauth.md