Skip to content

docs(admin): Improve database chapter titles / navigation - #15478

Open
joshtrichards wants to merge 11 commits into
masterfrom
jtr/docs-admin-db-ch-ordering
Open

docs(admin): Improve database chapter titles / navigation#15478
joshtrichards wants to merge 11 commits into
masterfrom
jtr/docs-admin-db-ch-ordering

Conversation

@joshtrichards

@joshtrichards joshtrichards commented Aug 24, 2026

Copy link
Copy Markdown
Member

☑️ Resolves

Summary:

  • Rename database configuration chapters with clearer, admin-friendly titles
  • Reorder the database documentation according to the administrator workflow
  • Clarify the distinction between read replicas and splitting tables or apps across databases
  • Remove the duplicate generic “Database configuration” chapter title

Details:

The database configuration landing page now introduces the topics in a more natural order:

  1. Set up a database server
  2. Enable MySQL/MariaDB 4-byte support
  3. Convert to a different database type
  4. Convert to 64-bit database identifiers
  5. Using database read replicas
  6. Splitting tables or apps across databases

The revised titles describe the administrator’s task or the result of the configuration rather than relying on implementation-specific terminology where possible (Note: I intend to do a follow-up PR for the 4-byte chapter which may further refine the title to make it more "friendly").

🖼️ Screenshots

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues

Signed-off-by: Josh <josh.t.richards@gmail.com>
Keeps it different from it's parent, which is already "Database Configuration" too.

Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
@nickvergessen
nickvergessen removed their request for review August 27, 2026 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants