docs: automated updates for config_change#581
Open
jessiemongeon1 wants to merge 2 commits into
Open
Conversation
Automated update based on: New key-server configuration option 'enable_event_monitoring' added to control committee rotation and package upgrade event monitoring. Enabled by default; can be set to false to disable. This is a new config field in key-server-config.yaml.
…#580 Automated update based on: New key-server configuration option 'enable_event_monitoring' added to control committee rotation and package upgrade event monitoring. Enabled by default; can be set to false to disable. This is a new config field in key-server-config.yaml.
Contributor
Author
Style Guide AuditAll 2 file(s) pass the style guide audit. |
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
Automated documentation updates triggered by recent release notes.
Changes
Triggered by MystenLabs/seal#580: [key-server] disable event monitoring with flag
docs/content/KeyServerOps.mdxdocs/content/KeyServerCommitteeOps.mdxReview details
docs/content/KeyServerOps.mdxThe documentation page needs to be updated to document the new
enable_event_monitoringconfiguration option.What needs updating
In the "Open mode" section
The paragraph that describes the config file settings (under "In the config file, make sure to:") should include a mention of the
enable_event_monitoringoption. Currently the bullet list coversnetwork,mode, andkey_server_object_id, but does not mentionenable_event_monitoring.Suggested addition — add a new bullet point to that list:
In the "Permissioned mode" section
The paragraph that describes creating the configuration file ("Next, create a configuration file in
.yamlformat following the instructions in the example configuration and with the following properties:") should also mention this option, since it applies to both modes.Suggested addition — add a bullet point or note:
Consider a general config reference note
Since the page already links to the example config in both modes, an alternative approach would be to add a brief section or note (perhaps after the "Network configuration" heading or as a shared note before the mode-specific sections) listing all available top-level config fields, including
enable_event_monitoring, with a short description:This would ensure operators are aware of the option regardless of which mode they are configuring.
docs/content/KeyServerCommitteeOps.mdxThe documentation page needs updating. The example
key-server-config.yamlshown in the Fresh DKG member runbook (step 5b) and potentially in the Key rotation member runbook does not mention the newenable_event_monitoringconfiguration option.What needs updating:
key-server-config.yamlblock currently shows:This should be updated to include the new
enable_event_monitoringfield with a brief explanation. Since it defaults totrue(enabled), it should be documented so operators know they can set it tofalseto disable committee rotation and package upgrade event monitoring. Suggested update:key-server-config.yamlafter rotation), the sameenable_event_monitoringfield should be documented there as well.What is currently wrong or missing:
enable_event_monitoringconfig field is not mentioned anywhere on this page. Operators setting up or reconfiguring their key servers would not know this option exists, nor that they can disable event monitoring if desired.Suggested addition:
After the example config block in step 5b (and any rotation config examples), add a note such as:
This PR was automatically generated by the Docs Impact Monitor. Please review the changes carefully before merging.
Each file edit was generated by Claude based on the release notes and a review of the existing documentation content.