Skip to content

OSDOCS-18373 HE-3 CQA B2: CQA editorial improvements for NFD - #117872

Merged
cbippley merged 1 commit into
openshift:mainfrom
cbippley:OSDOCS-18373-b2-split2
Aug 13, 2026
Merged

OSDOCS-18373 HE-3 CQA B2: CQA editorial improvements for NFD#117872
cbippley merged 1 commit into
openshift:mainfrom
cbippley:OSDOCS-18373-b2-split2

Conversation

@cbippley

@cbippley cbippley commented Aug 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Version(s): 4.20

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

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

QE review: NA, CQA

  • QE has approved this change.

Additional information:

This is part 2 of 2, split from #117336 for easier review. No merge conflicts with part 1 (#117871) — can be merged in either order.

Summary

  • Rewrites abstracts in nfd-rules-about.adoc and nfd-rules-using.adoc
  • Fixes wording (labelling → labeling, tightens sentences)
  • Replaces psap-using-node-feature-discovery-operator.adoc include with new nfd-using-operator-overview.adoc
  • Rewrites the assembly intro text

Test plan

  • Verify the assembly renders correctly with the updated modules
  • Verify abstract text appears properly in each module

🤖 Generated with Claude Code

@cbippley @claude
OSDOCS-18373 HE-3 CQA B2: CQA editorial improvements for NFD docs
a71c2d7 
Rewrite abstracts, fix wording in rules modules, and replace the
using-operator module with a clearer NFD Operator overview.

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

ocpdocs-previewbot commented Aug 12, 2026

Copy link
Copy Markdown

🤖 Wed Aug 12 18:31:07 - Prow CI generated the docs preview:

https://117872--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hardware_enablement/psap-node-feature-discovery-operator.html

@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

cbippley commented Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

Review Guide

4 files changed | +26 lines | -8 lines

Changes

# Section What changed
1 Assembly intro Rewrote abstract from passive ("Learn about…") to active ("You can use…")
2 NFD Operator overview New module replacing psap-using-node-feature-discovery-operator include
3 About NodeFeatureRule Consolidated 2 paragraphs into 1 abstract sentence
4 Using NodeFeatureRule Added abstract, fixed "labelling" → "labeling", tightened wording

Preview Links

# Section Link
1 Assembly intro View
2 NFD Operator overview View
3 About NodeFeatureRule View
4 Using NodeFeatureRule View

@cbippley

cbippley commented Aug 12, 2026

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
@lahinson lahinson added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Aug 13, 2026
lahinson
lahinson reviewed Aug 13, 2026
View reviewed changes

@lahinson lahinson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cbippley The changes look good to me, but I'm having a hard time verifying the text in the new module because I can't see where it came from. I'm hesitant to mark this as ok-to-merge until I can verify that.

@cbippley

cbippley commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

@lahinson The info comes from this already merged PR: https://github.com/openshift/openshift-docs/pull/117337/changes#diff-1ff74c1f70fde04d733f83854629e4efa231a2fa93b8815022aa7817a7a479c1L16

I had to split the PRs, and then split again to make it even smaller for review so some things got mixed up.

lahinson
lahinson reviewed Aug 13, 2026
View reviewed changes

@lahinson lahinson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the additional info, @cbippley! LGTM

@lahinson lahinson added ok-to-merge and removed merge-review-in-progress Signifies that the merge review team is reviewing this PR labels Aug 13, 2026
@cbippley
cbippley merged commit e733be0 into openshift:main Aug 13, 2026
2 checks passed
@cbippley

cbippley commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-5.0

@cbippley

cbippley commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.22

@cbippley

cbippley commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.21

@cbippley

cbippley commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.20

@openshift-cherrypick-robot

openshift-cherrypick-robot commented Aug 13, 2026

Copy link
Copy Markdown

@cbippley: new pull request created: #117965

Details

In response to this:

/cherrypick enterprise-5.0

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Aug 13, 2026
Merged
@openshift-cherrypick-robot

openshift-cherrypick-robot commented Aug 13, 2026

Copy link
Copy Markdown

@cbippley: new pull request created: #117966

Details

In response to this:

/cherrypick enterprise-4.22

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Aug 13, 2026
Merged
@openshift-cherrypick-robot

openshift-cherrypick-robot commented Aug 13, 2026

Copy link
Copy Markdown

@cbippley: new pull request created: #117967

Details

In response to this:

/cherrypick enterprise-4.20

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Aug 13, 2026
Merged
@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Aug 13, 2026
Merged
@openshift-cherrypick-robot

openshift-cherrypick-robot commented Aug 13, 2026

Copy link
Copy Markdown

@cbippley: new pull request created: #117968

Details

In response to this:

/cherrypick enterprise-4.21

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.

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

Reviewers

@lahinson lahinson lahinson left review comments

Assignees

No one assigned

Labels

branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 branch/enterprise-5.0 ok-to-merge size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

Continuous Release

Development

Successfully merging this pull request may close these issues.

4 participants

@cbippley @ocpdocs-previewbot @openshift-cherrypick-robot @lahinson