docs: host Cachet separately, plus v3.x feature corrections and additions#23
Merged
Merged
Conversation
Reconcile the v3.x docs with cachet/core: Corrections - components: fix status count (six, not five) and add Under Maintenance (6) - beacon: telemetry is enabled by default (opt out via CACHET_BEACON=false) - cachet: drop the stale "metrics not supported" warning - dashboard: user management is supported; link to the Users guide New/expanded coverage - add an Environment variables reference page - components: group visibility, collapse behaviour, and ordering strategies - incidents: stickied/pinned incidents - schedules: affected components and subscriber notifications - metrics: "show when empty" and reordering - cachet: language/localization, recent incidents only, dynamic favicon - api-keys: enumerate the resource abilities - api filtering: includes and metadata filtering
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.
Summary
Adds a hosting best-practice note to the v3.x introduction, then reconciles the v3.x documentation with the current behaviour in
cachethq/core— correcting several inaccurate pages and documenting features that were missing.Hosting guidance
<Warning>recommending that Cachet be hosted on infrastructure independent of the application/service it reports on, so the status page stays online during an outage.Corrections (docs disagreed with core)
config/cachet.php:env('CACHET_BEACON', true)). Docs previously said it was off by default. Now documents opting out viaCACHET_BEACON=false.New & expanded coverage
configuration/environment.mdxreference page covering theconfig/cachet.phpvariables, grouped by area, and added to the Configuration navigation.manage/deleteper resource).include(related resources) andfilter[meta][key](metadata filtering).Notes for reviewers
.env.examplethat setsCACHET_BEACON=false, the effective end-user default would differ — worth confirming.🤖 Generated with Claude Code
Generated by Claude Code