docs: cover the keep-in-Maintainerr-only collection option - #160
Merged
Conversation
Maintainerr#1ce589e2 adds a per-collection opt-in that stops a collection being created on the media server while everything else about it keeps running. Document it in the rule parameter table and in the Collections page, whose Media Server section promised the opposite. Add the three telemetry settings endpoints to the OpenAPI spec.
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.
Addresses the drift report in #159, checked against a local clone of
Maintainerrat14585915.What was added
docs/Rules.mdxKeep in Maintainerr onlyrow in the General parameter table, plus a paragraph on what it is for, that turning it on tears down an existing media-server collection and turning it off lets the next run recreate it, and that it is mutually exclusive withCustom collection1ce589e2, refined byb5e4206a(#3579)docs/Collections.md1ce589e2static/openapi-spec/maintainerr_api_specs.yamlGET /api/settings/telemetry/preview,GET /api/settings/telemetry/status,POST /api/settings/telemetry854e9ff1,1705d9e8Already covered by prior PRs
TELEMETRYvariable are documented in docs: describe the anonymous weekly usage report in Security #158. I re-verified both against1705d9e8andbfbcc0carather than assuming they still held:bfbcc0cadrops only a paragraph from About. TheSettings > About > Help us improve itentry point that Security.md names is still there.clientIdnow seeds the sample-week draw, but it stays local and is never sent, so "no identifier of any kind" is still accurate.telemetry.service.spec.tsasserts the serialized payload contains neither the key nor its value.1705d9e8dropslocaleand addscollectionItemsto the payload. Security.md describes the report in categories rather than field by field, so it needs no change.Deliberately skipped
639bf9f7*arr exclusion tag across several instancesAdd list exclusionsalready promises. Nothing in the docs claimed the single-instance limitd888b1b1,b5e4206ashared-collection teardown7200b7bamonaco served locallyTELEMETRY_URLdocs/API.mdAddKeepCollectionInMaintainerrOnly,AddTelemetryEnabledMigration.mdorConfiguration.mdNotes
introspectCommentsis off upstream, so the generator would not produce them. The request body follows the shape the plugin emits for a Zod-validated body, as onPOST /api/settings/metadata-provider.npm run buildis clean, the YAML parses, and the newRules.mdx#generallink resolves to a real anchor inside the same docs version.