Skip to content

OSDOCS-18373 HE-3 CQA B1: Split NFD configuration module - #117871

Open
cbippley wants to merge 1 commit into
openshift:mainfrom
cbippley:OSDOCS-18373-b2-split1
Open

OSDOCS-18373 HE-3 CQA B1: Split NFD configuration module#117871
cbippley wants to merge 1 commit into
openshift:mainfrom
cbippley:OSDOCS-18373-b2-split1

Conversation

@cbippley

@cbippley cbippley commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Version(s): 4.20

Issue: https://redhat.atlassian.net/browse/OSDOCS-18373

Link to docs preview: https://117871--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hardware_enablement/psap-node-feature-discovery-operator.html or see review guide below.

QE review: NA, CQA

  • QE has approved this change.

Additional information: Not really XL, the deleted file inflates the change count. Net change is only about 220 lines.

This is part 1 of 2, split from #117336 for easier review.

Summary

  • Splits the monolithic psap-configuring-node-feature-discovery.adoc (379 lines) into 3 focused reference modules:
    • nfd-configuring-core.adoc — core config parameters (sleepInterval, sources, labelWhiteList, noPublish)
    • nfd-configuring-core-klog.adoc — klog logging parameters
    • nfd-configuring-sources.adoc — source-specific parameters (CPU, kernel, PCI, USB, custom)
  • Updates the assembly to include the 3 new modules

Test plan

  • Verify the assembly renders the 3 new config sections correctly
  • Verify no content was lost from the original module

🤖 Generated with Claude Code

Split the monolithic psap-configuring-node-feature-discovery module
into three focused reference modules: core config, klog config, and
sources config.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci openshift-ci Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Aug 12, 2026
@ocpdocs-previewbot

Copy link
Copy Markdown

@openshift-ci

openshift-ci Bot commented Aug 12, 2026

Copy link
Copy Markdown

@cbippley: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@cbippley

Copy link
Copy Markdown
Contributor Author

Review Guide

5 files changed | +225 lines | -380 lines

Splits the monolithic psap-configuring-node-feature-discovery.adoc (379 lines) into 3 focused reference modules. No content added or removed — this is a structural reorganization with CQA formatting (definition lists, inline defaults, abstracts).

Changes

# Section What changed
1 Assembly includes Replaced 1 include with 3 new module includes
2 NFD core configuration Extracted sleepInterval, sources, labelWhiteList, noPublish into own module
3 NFD core klog configuration Extracted 13 klog parameters into own module, reformatted as definition list
4 NFD sources configuration Extracted CPU, kernel, PCI, USB, and custom source parameters into own module
5 Old monolith deleted psap-configuring-node-feature-discovery.adoc removed

Preview Links

# Section Link
1 Full page View
2 Core config parameters View
3 Core klog parameters View
4 Sources parameters View

Review tips

  • High line count (+225/-380) is due to file split, not new content
  • Verify each of the 3 new sections renders with definition lists and YAML examples
  • Confirm no parameters were lost from the original module

@cbippley

Copy link
Copy Markdown
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci Bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Aug 12, 2026
@cbippley cbippley added this to the Continuous Release milestone Aug 12, 2026
@cbippley

Copy link
Copy Markdown
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci Bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Aug 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 branch/enterprise-5.0 merge-review-needed Signifies that the merge review team needs to review this PR size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants