docs(deploying): Populate the stub Deploying page with useful info #2252

Merged
Aranjedeath merged 13 commits from stratself/continuwuity:stratself/docs-deployment-improvements into main 2026-10-03 15:52:21 +00:00
Member

The deploying.mdx page has been a stub for ages now. Useful info could be contained in there. So I added:

  • Detail Continuwuity's release tracks. This follows #1981 release schedule and recommendations of tracking main.
  • Add general update advises, and installation and post-installation stub sections

The intent is to make this the "homepage" of the deploying chapter. More commits needed to redirect rest of deploying subpages back to this new deploying.mdx.

I will also mark Nomad and K8s docs as either "community-provided" or "receiving little support", unsure of exact wording rn.

This pull request...

Pull request checklist:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
The `deploying.mdx` page has been a stub for ages now. Useful info could be contained in there. So I added: * Detail Continuwuity's release tracks. This follows #1981 release schedule and recommendations of tracking main. * Add general update advises, and installation and post-installation stub sections ~~The intent is to make this the "homepage" of the deploying chapter. More commits needed to redirect rest of deploying subpages back to this new `deploying.mdx`.~~ ~~I will also mark Nomad and K8s docs as either "community-provided" or "receiving little support", unsure of exact wording rn.~~ <!-- In order to help reviewers know what your pull request does at a glance, you should ensure that 1. Your PR title is a short, single sentence describing what you changed 2. You have described in more detail what you have changed, why you have changed it, what the intended effect is, and why you think this will be beneficial to the project. If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit from code comments, please don't mention them here - after opening your pull request, go to "files changed", and click on the "+" symbol in the line number gutter, and attach comments to the lines that you think would benefit from some clarification. --> This pull request... <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Closes: #... --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [x] This pull request targets the `main` branch, and the branch is named something other than `main`. - [x] I have written an appropriate pull request title and my description is clear. - [x] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [x] My contribution follows the [code style][c2], if applicable. - [x] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [x] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [x] My commit messages follow the [commit message format][c1cm] and are descriptive. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages
stratself changed title from WIP: WIP: docs(deploying): Populate the stub Deploying page with useful info and some smaller changes in deployment section to WIP: docs(deploying): Populate the stub Deploying page with useful info and some smaller changes in deployment section 2026-09-14 18:10:28 +00:00
stratself force-pushed stratself/docs-deployment-improvements from aab8301500
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m15s
to 81f39a75ba
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 13s
Checks / Prek / Check changed files (pull_request) Successful in 9s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m15s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m54s
2026-09-15 07:10:24 +00:00
Compare
stratself force-pushed stratself/docs-deployment-improvements from 43b7141f47
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m27s
to 74f0302e7a
All checks were successful
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 16s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m34s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m13s
2026-09-19 06:28:12 +00:00
Compare
stratself changed title from WIP: docs(deploying): Populate the stub Deploying page with useful info and some smaller changes in deployment section to WIP: docs(deploying): Populate the stub Deploying page with useful info 2026-09-19 06:28:36 +00:00
stratself force-pushed stratself/docs-deployment-improvements from 8001055715
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m35s
to 2cfdb3ab95
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 5s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 49s
2026-09-19 08:01:05 +00:00
Compare
stratself force-pushed stratself/docs-deployment-improvements from 2cfdb3ab95
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 5s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 49s
to 0f68c3e237
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m29s
2026-09-19 08:06:48 +00:00
Compare
stratself force-pushed stratself/docs-deployment-improvements from 0f68c3e237
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m29s
to 6d5a341242
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m28s
2026-09-21 18:11:31 +00:00
Compare
stratself force-pushed stratself/docs-deployment-improvements from 6d5a341242
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m28s
to ae0efee92e
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 11s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 5s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m6s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m19s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
2026-09-23 09:24:38 +00:00
Compare
stratself force-pushed stratself/docs-deployment-improvements from ae0efee92e
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 11s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 5s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m6s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m19s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
to c9f3606a98
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 8s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m45s
2026-09-23 10:01:33 +00:00
Compare
stratself changed title from WIP: docs(deploying): Populate the stub Deploying page with useful info to docs(deploying): Populate the stub Deploying page with useful info 2026-09-23 10:02:42 +00:00
stratself force-pushed stratself/docs-deployment-improvements from c9f3606a98
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 8s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m45s
to 1d4055290b
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 5s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m5s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m41s
2026-09-26 16:02:14 +00:00
Compare
Aranjedeath approved these changes 2026-09-26 17:08:52 +00:00
Dismissed
lveneris requested changes 2026-09-26 22:52:52 +00:00
Dismissed
@ -4,0 +13,4 @@
## Release tracks
Continuwuity offers two release tracks to accommodate different needs: tracking the **main branch** of the [repository], and following the **regular release** schedule.
Member

"regular" seems to promise too much, and i feel like "release schedule" is the important part to highlight

"regular" seems to promise too much, and i feel like "release schedule" is the important part to highlight
stratself marked this conversation as resolved
@ -4,0 +17,4 @@
### Main branch
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.
Member

"is rapidly evolving software, we encourage deployments to follow the main branch to receive the latest fixes and features."

"is rapidly evolving software, we encourage deployments to follow the `main` branch to receive the latest fixes and features."
stratself marked this conversation as resolved
@ -4,0 +26,4 @@
### 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 not suitable or possible (such as when tracking with third-party packaging).
Member

"They are suitable in cases where updating more frequently is not viable, such as when using third-party packaging."

"They are suitable in cases where updating more frequently is not viable, such as when using third-party packaging."
stratself marked this conversation as resolved
@ -4,0 +28,4 @@
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.
Member

"they may contain"

"they may contain"
stratself marked this conversation as resolved
@ -4,0 +93,4 @@
## Post-installation
After successfully deploying Continuwuity, these next steps can be done:
Member

"After Continuwuity is up and running, consider the following:"

"After Continuwuity is up and running, consider the following:"
stratself marked this conversation as resolved
@ -4,0 +103,4 @@
- Consult the [**Maintenance**](./maintenance.mdx) page for guidance on maintaining your homeserver.
- If you want to set up an appservice, take a look at the [**Appservice Guide**](./appservices.mdx).
Member

"Appservices Guide"

"Appservices Guide"
stratself marked this conversation as resolved
@ -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.
Member

does this guide also work for podman, out of interest? if so, it could be cool to make a separate PR that makes it a generic OCI guide

does this guide also work for podman, out of interest? if so, it could be cool to make a separate PR that makes it a generic OCI guide
Author
Member

It technically works with podman compose but Quadlet is a different thing. Could consider adding a note for podman compose compat, but caveats galore (e.g. rootlessness, quirks, so on)

It technically works with `podman compose` but Quadlet is a different thing. Could consider adding a note for `podman compose` compat, but caveats galore (e.g. rootlessness, quirks, so on)
lveneris marked this conversation as resolved
stratself force-pushed stratself/docs-deployment-improvements from cb27fcf4fd
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 5s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m50s
to 93f4e0076c
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m18s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m45s
2026-09-27 04:51:42 +00:00
Compare
lveneris approved these changes 2026-09-27 07:49:57 +00:00
stratself force-pushed stratself/docs-deployment-improvements from 93f4e0076c
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m18s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m45s
to 4d961fabe4
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m9s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m40s
2026-10-01 19:32:35 +00:00
Compare
Aranjedeath referenced this pull request from a commit 2026-10-03 15:52:22 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
continuwuation/continuwuity!2252
No description provided.