diff --git a/docs/deploying.mdx b/docs/deploying.mdx index 3b8405e6e..76c610a5b 100644 --- a/docs/deploying.mdx +++ b/docs/deploying.mdx @@ -1,11 +1,12 @@ # Deploying -This chapter describes various ways to deploy Continuwuity. Read more on this page for useful general information. +This chapter describes various ways to deploy Continuwuity. Read more on this page for useful general information, and then proceed to one of the deployment methods. :::tip Getting help -If you run into any problems while setting up Continuwuity, ask us in `#continuwuity:continuwuity.org` or [open an issue on Forgejo][forgejo-new-issue]. +If you run into any problems while setting up Continuwuity, ask us in [`#continuwuity:continuwuity.org`][support-room] or [open an issue on Forgejo][forgejo-new-issue]. ::: +[support-room]: https://matrix.to/#/%23continuwuity:continuwuity.org [forgejo-new-issue]: https://forgejo.ellis.link/continuwuation/continuwuity/issues/new ## Release tracks @@ -14,16 +15,16 @@ ## Release tracks ### Main branch -The main branch [repository]. As Continuwuity is a rapidly evolving software, we encourage deployments to follow it where possible to receive the latest bugfixes and features. Commits in main are stable and have been thoroughly tested by the maintainers before merging. +As Continuwuity is a rapidly evolving software, we encourage deployments to follow the `main` branch where possible to receive the latest bugfixes and features. Commits in main are stable and have been thoroughly tested by the maintainers before merging. -To be notified of new updates to main, it is best track the [`/changelog.d`][changelog-d] directory in the repository, which contains changelog snippets from merged pull requests. These may include breaking changes, so . Then, proceed to update or build Continuwuity according to your deployment method. +To be notified of new updates to main, it is best track the [`/changelog.d`][changelog-d] directory in the repository, which contains changelog snippets from merged pull requests. These may include breaking changes. Then, proceed to update or build Continuwuity according to your deployment method. [repository]: https://forgejo.ellis.link/continuwuation/continuwuity [changelog-d]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/changelog.d ### Regular releases -Regular releases are periodic, versioned cutoffs from the main branch from time to time, and can be found on the [Releases] page. They are suitable for cases where updating regularly are inconvenient or not possible (such as when tracking with third-party packaging). +Regular releases are periodic, versioned cutoffs from the main branch from time to time, and can be found on the [Releases] page. They are suitable for cases where updating regularly are not suitable or possible (such as when tracking with third-party packaging). For regular releases, **always read the release notes before upgrading to a new version**, as it may contain breaking changes that affect your deployment. diff --git a/docs/deploying/arch-linux.mdx b/docs/deploying/arch-linux.mdx index 70067abce..928d1c8e5 100644 --- a/docs/deploying/arch-linux.mdx +++ b/docs/deploying/arch-linux.mdx @@ -1,5 +1,11 @@ # Continuwuity for Arch Linux -Continuwuity is available in the `archlinuxcn` repository and AUR with the same package name `continuwuity`, which includes the latest tagged version. The development version is available on AUR as `continuwuity-git`. +Continuwuity is available in the [`archlinuxcn`][archlinuxcn] repository and AUR with the same package name, [`continuwuity`][aur-continuwuity]. -Simply install the `continuwuity` package. Configure the service in `/etc/conduwuit/conduwuit.toml`, then enable and start the continuwuity.service. +The development version is available on the AUR as [`continuwuity-git`][aur-continuwuity-git]. + +[archlinuxcn]: https://www.archlinuxcn.org/ +[aur-continuwuity]: https://aur.archlinux.org/packages/continuwuity +[aur-continuwuity-git]: https://aur.archlinux.org/packages/continuwuity-git + +Simply install the `continuwuity` package. Configure the service in `/etc/conduwuit/conduwuit.toml`, then enable and start the `continuwuity.service`. diff --git a/docs/deploying/docker.mdx b/docs/deploying/docker.mdx index 837687ea1..d7133ee68 100644 --- a/docs/deploying/docker.mdx +++ b/docs/deploying/docker.mdx @@ -1,15 +1,17 @@ # Continuwuity for Docker +This page describes how to deploy Continuwuity via Docker containers. Make sure that you have installed `docker` on your system before continuing. + ## Preparation ### Choose an image The following OCI images are available for Continuwuity: -| Image | Notes | +| Image | Notes | | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [https://forgejo.ellis.link/continuwuation/continuwuity:**latest**][latest] | Latest tagged release. (recommended) | -| [https://forgejo.ellis.link/continuwuation/continuwuity:**main**][main] | Latest `main` branch commit. Built with [CI][release-image] | +| [https://forgejo.ellis.link/continuwuation/continuwuity:**latest**][latest] | Latest tagged release. | +| [https://forgejo.ellis.link/continuwuation/continuwuity:**main**][main] | Latest `main` branch commit. Built with [CI][release-image] | | [https://forgejo.ellis.link/continuwuation/continuwuity:**latest-maxperf**][latest-maxperf] | Latest tagged release, [performance optimised version](./generic.mdx#performance-optimised-builds). | | [https://forgejo.ellis.link/continuwuation/continuwuity:**main-maxperf**][main-maxperf] | Latest `main` branch commit, [performance optimised version](./generic.mdx#performance-optimised-builds). | diff --git a/docs/deploying/freebsd.mdx b/docs/deploying/freebsd.mdx index b56d84fab..33c163e66 100644 --- a/docs/deploying/freebsd.mdx +++ b/docs/deploying/freebsd.mdx @@ -4,4 +4,6 @@ # Continuwuity for FreeBSD Please see the installation instructions in that repository. Direct any questions to its issue tracker or to [@katie:kat5.dev](https://matrix.to/#/@katie:kat5.dev). -For general BSD support, please join our [Continuwuity BSD](https://matrix.to/#/%23bsd:continuwuity.org) community room. +For general BSD support, please join our [Continuwuity support room][support-room]. + +[support-room]: https://matrix.to/#/%23continuwuity:continuwuity.org diff --git a/docs/deploying/generic.mdx b/docs/deploying/generic.mdx index 3041abd89..cbcac08ac 100644 --- a/docs/deploying/generic.mdx +++ b/docs/deploying/generic.mdx @@ -1,6 +1,6 @@ # Generic deployment documentation -This page is concerned with deploying Continuwuity on a generic Linux distro, via a systemd service file. It also contains routing instructions for reverse proxies. +This page provides instructions on deploying Continuwuity on a generic Linux distro via a systemd service file. It also contains common routing instructions for reverse proxies. ## Installing Continuwuity diff --git a/pkg/debian/README.md b/pkg/debian/README.md index 68a247bc0..f3abb1ec3 100644 --- a/pkg/debian/README.md +++ b/pkg/debian/README.md @@ -42,4 +42,4 @@ ## Running ## What's next? -Navigate to [Post-installation](../deploying.mdx#post-installation) for next steps. +Navigate to [Post-installation](/deploying#post-installation) for next steps.