From 45137515a6b053a398a802ed36124b46af053408 Mon Sep 17 00:00:00 2001 From: Erik Michelson Date: Wed, 18 May 2022 10:31:02 +0200 Subject: [PATCH] fix(docs): title case, community page improvements Signed-off-by: Erik Michelson --- docs/content/dev/getting-started.md | 2 +- docs/content/setup/community.md | 8 +++++--- docs/mkdocs.yml | 4 ++-- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/content/dev/getting-started.md b/docs/content/dev/getting-started.md index 76b0609fa..4dbb372ac 100644 --- a/docs/content/dev/getting-started.md +++ b/docs/content/dev/getting-started.md @@ -2,7 +2,7 @@ ## Preparing for running the code -**Notice:** *There's [specialised instructions for docker](../setup/docker.md) if you prefer running code this way!* +**Notice:** *There are [specialised instructions for docker](../setup/docker.md) if you prefer running code this way!* 1. Clone the repository with `git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc-server` (cloning is the preferred way, but you can also download and unzip a release) diff --git a/docs/content/setup/community.md b/docs/content/setup/community.md index 33aba8278..7b87080cc 100644 --- a/docs/content/setup/community.md +++ b/docs/content/setup/community.md @@ -1,16 +1,18 @@ -# Community installation methods +# Community Installation Methods The HedgeDoc community has created and tested many options for deploying HedgeDoc on other platforms or operating systems. You can check them out below. Feel free to create a PR to add your tested community installation method. +These are not officially supported by the HegeDoc maintainers. If you encounter issues or have questions, please first reach out to downstream packagers. + ## Container Deployments -### LinuxServer.io Docker image +### LinuxServer.io Docker Image [![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.") [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-hedgedoc.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-hedgedoc/releases) -[LinuxServer.io](https://linuxserver.io) have created an Ubuntu-based multi-arch container image for x86-64, arm64 and armhf. +[LinuxServer.io](https://linuxserver.io) have created an Alpine-based multi-arch container image for x86-64, arm64 and armhf. - It supports all the environment variables detailed in the [configuration documentation](../configuration.md) to modify it according to your needs. - It gets rebuilt on new releases from HedgeDoc and also weekly if necessary to update any other package changes in the underlying container, making it easy to keep your HedgeDoc instance up to date. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index af2df75f4..d8688ea51 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -9,10 +9,10 @@ nav: - Home: index.md - Installation: - 'Getting Started': setup/getting-started.md - - Official installation methods: + - Official Installation Methods: - 'Docker Image': setup/docker.md - 'Manual Installation': setup/manual-setup.md - - 'Community installation methods': setup/community.md + - 'Community Installation Methods': setup/community.md - Guides: - 'Reverse Proxy': guides/reverse-proxy.md - Authentication: