Skip to content

docs: automated updates for config_change#581

Open
jessiemongeon1 wants to merge 2 commits into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260604-211550
Open

docs: automated updates for config_change#581
jessiemongeon1 wants to merge 2 commits into
MystenLabs:mainfrom
jessiemongeon1:docs-monitor/auto-update-20260604-211550

Conversation

@jessiemongeon1

Copy link
Copy Markdown
Contributor

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.mdx
  • 🟡 docs/content/KeyServerCommitteeOps.mdx

Review details

docs/content/KeyServerOps.mdx

The documentation page needs to be updated to document the new enable_event_monitoring configuration 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_monitoring option. Currently the bullet list covers network, mode, and key_server_object_id, but does not mention enable_event_monitoring.

Suggested addition — add a new bullet point to that list:

  • Optionally set enable_event_monitoring to control whether the key server monitors onchain events for committee rotation and package upgrades. This is enabled (true) by default. Set to false to disable event monitoring.

In the "Permissioned mode" section

The paragraph that describes creating the configuration file ("Next, create a configuration file in .yaml format 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:

  • Optionally set enable_event_monitoring to false to disable committee rotation and package upgrade event monitoring (enabled by default).

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:

enable_event_monitoring (optional, default: true): Controls whether the key server monitors onchain events for committee rotation and package upgrades. Set to false to disable.

This would ensure operators are aware of the option regardless of which mode they are configuring.

docs/content/KeyServerCommitteeOps.mdx

The documentation page needs updating. The example key-server-config.yaml shown in the Fresh DKG member runbook (step 5b) and potentially in the Key rotation member runbook does not mention the new enable_event_monitoring configuration option.

What needs updating:

  1. Fresh DKG member runbook, Step 5b — The example key-server-config.yaml block currently shows:
network: Testnet
server_mode: !Committee
  member_address: '<MY_ADDRESS>'
  key_server_obj_id: '<KEY_SERVER_OBJ_ID>'
  committee_state: !Active

This should be updated to include the new enable_event_monitoring field with a brief explanation. Since it defaults to true (enabled), it should be documented so operators know they can set it to false to disable committee rotation and package upgrade event monitoring. Suggested update:

network: Testnet
server_mode: !Committee
  member_address: '<MY_ADDRESS>'
  key_server_obj_id: '<KEY_SERVER_OBJ_ID>'
  committee_state: !Active
enable_event_monitoring: true  # Set to false to disable monitoring of committee rotation and package upgrade events
  1. Key rotation member runbook — The page content was truncated, but if there is a similar config example in the key rotation member section (where members update their key-server-config.yaml after rotation), the same enable_event_monitoring field should be documented there as well.

What is currently wrong or missing:

  • The enable_event_monitoring config 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:

The enable_event_monitoring option controls whether the key server monitors onchain events for committee rotation and package upgrades. It is enabled (true) by default. Set it to false to disable this monitoring.


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.

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.
@jessiemongeon1

Copy link
Copy Markdown
Contributor Author

Style Guide Audit

All 2 file(s) pass the style guide audit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant