docs(deploying): Populate the stub Deploying page with useful info #2252
No reviewers
Labels
No labels
Abandoned
Blocked
Bug
Changelog
Added
Changelog
Missing
Changelog
None
Cherry-picking
Database
Dependencies
Dependencies/Renovate
Difficulty
Easy
Difficulty
Hard
Difficulty
Medium
Documentation
Enhancement
Good first issue
Help wanted
Inherited
Matrix/Administration
Matrix/Appservices
Matrix/Auth
Matrix/Client
Matrix/Core
Matrix/E2EE
Matrix/Federation
Matrix/Hydra
Matrix/MSC
Matrix/Media
Matrix/T&S
Merge
Merge/Manual
Merge/Squash
Meta
Meta/CI
Meta/Packaging
Priority
Blocking
Priority
High
Priority
Low
Security
Status
Confirmed
Status
Duplicate
Status
Invalid
Status
Needs Investigation
Support
bob the builder
No milestone
No assignees
3 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
continuwuation/continuwuity!2252
Loading…
Reference in a new issue
No description provided.
Delete branch "stratself/continuwuity:stratself/docs-deployment-improvements"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
The
deploying.mdxpage has been a stub for ages now. Useful info could be contained in there. So I added:The intent is to make this the "homepage" of the deploying chapter. More commits needed to redirect rest of deploying subpages back to this newdeploying.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:
mainbranch, and the branch is named something other thanmain.myself, if applicable. This includes ensuring code compiles.
WIP: WIP: docs(deploying): Populate the stub Deploying page with useful info and some smaller changes in deployment sectionto WIP: docs(deploying): Populate the stub Deploying page with useful info and some smaller changes in deployment sectionaab830150081f39a75ba43b7141f4774f0302e7aWIP: docs(deploying): Populate the stub Deploying page with useful info and some smaller changes in deployment sectionto WIP: docs(deploying): Populate the stub Deploying page with useful info80010557152cfdb3ab952cfdb3ab950f68c3e2370f68c3e2376d5a3412426d5a341242ae0efee92eae0efee92ec9f3606a98WIP: docs(deploying): Populate the stub Deploying page with useful infoto docs(deploying): Populate the stub Deploying page with useful infoc9f3606a981d4055290b@ -4,0 +13,4 @@## Release tracksContinuwuity offers two release tracks to accommodate different needs: tracking the **main branch** of the [repository], and following the **regular release** schedule."regular" seems to promise too much, and i feel like "release schedule" is the important part to highlight
@ -4,0 +17,4 @@### Main branchAs 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."is rapidly evolving software, we encourage deployments to follow the
mainbranch to receive the latest fixes and features."@ -4,0 +26,4 @@### Regular releasesRegular 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)."They are suitable in cases where updating more frequently is not viable, such as when using third-party packaging."
@ -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."they may contain"
@ -4,0 +93,4 @@## Post-installationAfter successfully deploying Continuwuity, these next steps can be done:"After Continuwuity is up and running, consider the following:"
@ -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)."Appservices Guide"
@ -1,15 +1,17 @@# Continuwuity for DockerThis page describes how to deploy Continuwuity via Docker containers. Make sure that you have installed `docker` on your system before continuing.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
It technically works with
podman composebut Quadlet is a different thing. Could consider adding a note forpodman composecompat, but caveats galore (e.g. rootlessness, quirks, so on)cb27fcf4fd93f4e0076c93f4e0076c4d961fabe4