Skip to content

docs: Rework the Operations section for 4.0 - #720

Merged
developerjamiu merged 12 commits into
mainfrom
concepts-phase3-section7-operations
Jul 28, 2026
Merged

docs: Rework the Operations section for 4.0#720
developerjamiu merged 12 commits into
mainfrom
concepts-phase3-section7-operations

Conversation

@developerjamiu

Copy link
Copy Markdown
Contributor

Summary

Section-by-section rework of the Operations concept pages for Serverpod 4.0, following the Data & the database (#696), Web server (#711), and Scheduling (#719) passes. The section gains an entry point, loses the two topics that did not belong to it, and every remaining page was checked against the framework source.

Changes

  • New Overview page. The section now opens with what Operations covers and links the pages under it.
  • Caching moves to Endpoints & APIs, next to Sessions and Server events, since it is a Session facility rather than a run-in-production concern. The page now documents invalidation, cache groups, the entry limit and eviction order, and the four caches rather than three.
  • Experimental features is replaced by Exception monitoring, named for its actual subject. Shutdown tasks move to Running your server, the diagnostic-handler test example moves to Advanced testing examples, and the CLI flag table (whose only row enabled nothing in 4.0) is dropped.
  • Logging: separates the four kinds of record, tables the settings with their environment variables and real defaults, and documents runtime log settings and the conditions under which log purging is disabled.
  • Health checks: separates the HTTP probes from the metrics collection, which share a name but are unrelated APIs, and corrects the response format and metric cadence.
  • Security and TLS: leads with the common case (Serverpod Cloud terminates TLS for you, a proxy usually does otherwise) before the case where the server does it itself.

Notes

  • Two code samples in the section did not compile as written and are fixed: the CacheMissHandler example returned a nullable value from a non-nullable method, and the ServerHealthMetric example omitted the required granularity argument.
  • /startupz no longer claims to verify migrations or to govern traffic routing; readiness governs routing.
  • The global cache falls back to an in-memory, per-instance cache whenever Redis is not configured, in every run mode. This was previously documented as a development-only fallback.
  • Cloud logs and the Redis guide now link to their framework counterparts.

@developerjamiu developerjamiu self-assigned this Jul 27, 2026
@developerjamiu developerjamiu added the documentation Improvements or additions to documentation label Jul 27, 2026
…e3-section7-operations

# Conflicts:
#	docs/06-concepts/01-server-fundamentals/02-running-your-server.md
@developerjamiu
developerjamiu changed the base branch from main to concepts-phase3-section6-scheduling July 27, 2026 15:14

@Zfinix Zfinix left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Caching moving to endpoints-and-apis and experimental-features going away both change URLs, they need redirects too.

Comment thread docs/06-concepts/07-operations/02-logging.md
Comment thread docs/06-concepts/07-operations/02-logging.md Outdated
Comment thread docs/06-concepts/07-operations/05-exception-monitoring.md Outdated
Comment thread docs/06-concepts/02-endpoints-and-apis/06-caching.md Outdated
Comment thread docs/06-concepts/07-operations/03-health-checks.md
Base automatically changed from concepts-phase3-section6-scheduling to main July 28, 2026 09:34
…on7-operations

# Conflicts:
#	docs/06-concepts/01-server-fundamentals/02-running-your-server.md
@developerjamiu
developerjamiu requested a review from Zfinix July 28, 2026 10:42

@Zfinix Zfinix left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 🚀

@developerjamiu
developerjamiu merged commit 7d0cf75 into main Jul 28, 2026
4 checks passed
@developerjamiu
developerjamiu deleted the concepts-phase3-section7-operations branch July 28, 2026 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants