Skip to content

Add production deployment docs#36

Merged
nscuro merged 1 commit intomainfrom
deployment-docs
Apr 28, 2026
Merged

Add production deployment docs#36
nscuro merged 1 commit intomainfrom
deployment-docs

Conversation

@nscuro
Copy link
Copy Markdown
Member

@nscuro nscuro commented Apr 28, 2026

Also refines scaling docs, and adds backup and upgrading guides. These will likely need refinement as users try to make sense of them, but it's a starting point, and better what we had previously (i.e. nothing).

Copilot AI review requested due to automatic review settings April 28, 2026 22:53
@nscuro nscuro added the enhancement New feature or request label Apr 28, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an initial set of production-oriented administration documentation and updates existing docs to link into the new operational guidance (production deployment baseline, scaling refinements, backup/restore, and rolling upgrades), plus a new architecture “deployment topology” concept page.

Changes:

  • Introduces new administration guides: Deploying to production, Backing up and restoring, and Upgrading running instances.
  • Refactors the Scaling guide to focus on web/worker separation, throughput levers, connection pooling, vertical scaling, and isolating the engine database.
  • Adds an architecture Deployment topology page and updates navigation/quickstart “What’s next” links to surface the new guidance.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/tutorials/quickstart.md Updates “What’s next” links to point to production deployment guidance and other next steps.
docs/reference/configuration/dex-engine.md Updates scaling deep-link to the new/renamed scaling section anchor.
docs/reference/configuration/application.md Documents default JVM flags and how to extend them via EXTRA_JAVA_OPTIONS.
docs/guides/administration/deploying-to-production.md New baseline production deployment guide (sizing, HA, TLS, observability, backup/upgrade planning).
docs/guides/administration/scaling.md Reworks scaling guidance around workload separation, throughput tuning, pooling, vertical scaling, and engine DB isolation.
docs/guides/administration/backing-up.md New backup/restore guidance including engine DB considerations and post-restore behavior.
docs/guides/administration/upgrading-instances.md New rolling-upgrade guidance for multi-instance clusters, including web/worker split considerations.
docs/guides/administration/.pages Adds new guides to the Administration navigation in a more logical order.
docs/concepts/architecture/index.md Adds a topology section linking to the new deployment topology page.
docs/concepts/architecture/deployment.md New deployment topology/coordination/recovery conceptual documentation (with diagram).
docs/concepts/architecture/.pages Adds the new deployment topology page to the Architecture navigation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/reference/configuration/application.md Outdated
Also refines scaling docs, and adds backup and upgrading guides. These will likely need refinement as users try to make sense of them, but it's a starting point, and better what we had previously (i.e. nothing).

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro merged commit 380a541 into main Apr 28, 2026
5 checks passed
@nscuro nscuro deleted the deployment-docs branch April 28, 2026 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants