Summary
Add a dedicated Configuration section to the user documentation for CLP components. Start with compression-coordinator, and use a configuration-list format consistent with the Spider scheduler guide.
Rationale
The compression-coordinator guide describes configuration values in feature-specific text. A dedicated Configuration section gives users one location to find all supported settings. The same documentation pattern should be available for other CLP components.
Affected areas
docs/src/user-docs/guides-using-compression-coordinator.md
- Related component guide pages under
docs/src/user-docs/
- Documentation navigation or shared configuration-list conventions, if needed
Required changes
- Define a reusable documentation structure for component-level
Configuration sections.
- Add a
Configuration section to the compression-coordinator guide.
- List supported
compression-coordinator configuration values and their meanings.
- Link each setting to its authoritative configuration reference where available.
- Identify and apply the same structure to other component guides as appropriate.
Acceptance criteria
- The
compression-coordinator guide has a dedicated Configuration section.
- The section provides a complete, user-facing list of supported
compression-coordinator settings.
- The formatting is consistent with the Spider scheduler guide configuration list.
- The documentation clearly distinguishes component-specific settings from Spider scheduler settings.
- The approach supports adding equivalent sections to other component guides.
Backlinks
Requested by: @LinZhihao-723
Summary
Add a dedicated
Configurationsection to the user documentation for CLP components. Start withcompression-coordinator, and use a configuration-list format consistent with the Spider scheduler guide.Rationale
The
compression-coordinatorguide describes configuration values in feature-specific text. A dedicatedConfigurationsection gives users one location to find all supported settings. The same documentation pattern should be available for other CLP components.Affected areas
docs/src/user-docs/guides-using-compression-coordinator.mddocs/src/user-docs/Required changes
Configurationsections.Configurationsection to thecompression-coordinatorguide.compression-coordinatorconfiguration values and their meanings.Acceptance criteria
compression-coordinatorguide has a dedicatedConfigurationsection.compression-coordinatorsettings.Backlinks
compression-coordinator. #2456compression-coordinator. #2456 (comment)Requested by: @LinZhihao-723