Conversation
There was a problem hiding this comment.
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.
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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).