Skip to content

OU-1389: update documentation with new frontend folder structure - #1055

Merged
openshift-merge-bot[bot] merged 1 commit into
openshift:mainfrom
PeterYurkovich:ou-1389-6
Jul 15, 2026
Merged

openshift-merge-bot[bot] merged 1 commit into
openshift:mainfrom
PeterYurkovich:ou-1389-6

Conversation

@PeterYurkovich

@PeterYurkovich PeterYurkovich commented Jul 14, 2026 •

Copy link
Copy Markdown
Contributor

Update monitoring plugin documentation based on new folder structure

Summary by CodeRabbit

  • New Features

    • Expanded feature-flag support to include legacy dashboards, metrics, targets, and cluster health analysis alongside alerting, incidents, and Perses dashboards.
    • The app now exposes feature availability as a unified set of flags.
  • Documentation

    • Updated frontend contribution and layout guidance to reflect the current features vs shared organization.
    • Refreshed debugging and dashboard documentation, including updated testing guidance and example import paths.
    • Corrected README feature-flag references and aligned backend/contribution examples.

@PeterYurkovich PeterYurkovich changed the title feat: update documentation with new frontend folder structure OU-1389: update documentation with new frontend folder structure Jul 14, 2026
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 14, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 14, 2026 •

Copy link
Copy Markdown

@PeterYurkovich: This pull request references OU-1389 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Update monitoring plugin documentation based on new folder structure

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci
openshift-ci Bot requested review from etmurasaki and jgbernalp July 14, 2026 19:55
@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 14, 2026
@coderabbitai

coderabbitai Bot commented Jul 14, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 628990b7-6372-46e4-a1ba-1af792bb17c0

📥 Commits

Reviewing files that changed from the base of the PR and between 13963b0 and 574d3ef.

📒 Files selected for processing (5)
  • AGENTS.md
  • CONTRIBUTING.md
  • README.md
  • web/cypress/CYPRESS_TESTING_GUIDE.md
  • web/src/shared/hooks/useFeatures.ts
🚧 Files skipped from review as they are similar to previous changes (4)
  • web/cypress/CYPRESS_TESTING_GUIDE.md
  • CONTRIBUTING.md
  • AGENTS.md
  • web/src/shared/hooks/useFeatures.ts

Walkthrough

Documentation now reflects the web/src/features/ and web/src/shared/ structure. Testing and feature-flag references were updated, while useFeatures supports additional flags and returns the combined feature state.

Changes

Frontend structure and feature flags

Layer / File(s) Summary
Updated repository guidance
AGENTS.md, CONTRIBUTING.md, README.md, web/cypress/CYPRESS_TESTING_GUIDE.md
Frontend placement, dashboard paths, test imports, test IDs, backend package examples, test file guidance, and feature-flag references now use the updated repository structure.
Expanded feature flag hook contract
web/src/shared/hooks/useFeatures.ts
useFeatures supports additional flags, applies defaults, and returns the complete merged feature object.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: jgbernalp, etmurasaki

🚥 Pre-merge checks | ✅ 15
✅ Passed checks (15 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the main documentation update about the new frontend folder structure, though it omits the hook code change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed PR only changes docs and a feature hook; no Ginkgo test titles or test files were added or edited, so no unstable names are present.
Test Structure And Quality ✅ Passed No Ginkgo test code was changed; the PR only touches docs and one non-test hook file.
Microshift Test Compatibility ✅ Passed HEAD changes are docs plus a TS hook update; no new Ginkgo e2e tests or MicroShift-unsafe APIs were added.
Single Node Openshift (Sno) Test Compatibility ✅ Passed PR only updates docs and a shared hook; no new Ginkgo e2e tests or SNO-sensitive assumptions were added.
Topology-Aware Scheduling Compatibility ✅ Passed PR only changes docs and a frontend feature-flag hook; no manifests, controllers, or scheduling constraints were added.
Ote Binary Stdout Contract ✅ Passed Only a React hook and docs changed; no main/init/TestMain/suite setup or stdout APIs were added in touched files.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed PR only changes docs and a feature hook; no Ginkgo e2e tests were added or modified, so IPv4/disconnected-network checks don’t apply.
No-Weak-Crypto ✅ Passed PR only updates docs and a feature-flag hook; no weak crypto, custom crypto, or secret/token comparisons appear in the changed files.
Container-Privileges ✅ Passed PR only changes docs and one TS hook; no container/K8s manifests or privilege fields were added.
No-Sensitive-Data-In-Logs ✅ Passed No new logging statements or secret/PII fields were added; changes are docs plus a hook defaults update only.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 7: Update the README feature-flags paragraph to reference the exported
useFeatures hook instead of useFeature, and replace each non-descriptive “here”
link label with descriptive labels: “Feature enum,” “useFeatures hook,” and
“acm-alerting patch,” while preserving the existing link targets and content.

In `@web/src/shared/hooks/useFeatures.ts`:
- Around line 15-24: Update the FeaturesResponse type so the
cluster-health-analyzer property is optional, matching the other feature flags
and allowing responses merged with noFeatures to omit it.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: cae43346-fd5e-492d-b80f-bb3d4d078f96

📥 Commits

Reviewing files that changed from the base of the PR and between cbab71e and 13963b0.

📒 Files selected for processing (5)
  • AGENTS.md
  • CONTRIBUTING.md
  • README.md
  • web/cypress/CYPRESS_TESTING_GUIDE.md
  • web/src/shared/hooks/useFeatures.ts

Comment thread README.md Outdated
Comment thread web/src/shared/hooks/useFeatures.ts
@PeterYurkovich

Copy link
Copy Markdown
Contributor Author

/label qe-approved
No code changes

@openshift-ci openshift-ci Bot added the qe-approved Signifies that QE has signed off on this PR label Jul 14, 2026
@jgbernalp

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 15, 2026
@openshift-ci

openshift-ci Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jgbernalp, PeterYurkovich

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [PeterYurkovich,jgbernalp]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci

openshift-ci Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

@PeterYurkovich: 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.

@openshift-merge-bot
openshift-merge-bot Bot merged commit b654a31 into openshift:main Jul 15, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. qe-approved Signifies that QE has signed off on this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants