Skip to content

RHDHBUGS-3277: Missing prerequisites and configuration details for Scorecard Aggregation cards - #2346

Merged
deerskindoll merged 16 commits into
redhat-developer:release-1.10from
rh-tokeefe:RHDHBUGS-3277
Jul 30, 2026
Merged

deerskindoll merged 16 commits into
redhat-developer:release-1.10from
rh-tokeefe:RHDHBUGS-3277

Conversation

@rh-tokeefe

Copy link
Copy Markdown
Member

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s):
release 1.10
Issue:
https://redhat.atlassian.net/browse/RHDHBUGS-3277
Preview:

@rhdh-bot

rhdh-bot commented Jun 8, 2026 •

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 35/35 titles | 79s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2346/


Content Quality Assessment

CQA Report

  • CQA-00a: Orphaned modules
  • CQA-00b: Directory structure
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure
  • CQA-03: Verify content type metadata
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements
  • CQA-06: Verify assemblies follow official template (one user story)
  • CQA-07: Verify TOC depth (max 3 levels)
  • CQA-08: Verify short description content quality
  • CQA-09: Verify short description format
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-11: Verify procedure prerequisites
  • CQA-12: Verify grammar and style (Vale)
  • CQA-13: Verify content matches declared type
  • CQA-14: Verify no broken links
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 19 pass, 0 fail

19 checks: 19 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.


Updated 2026-07-30 18:34:59 UTC

@dzemanov dzemanov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@rh-tokeefe can you please also address in this PR bullet points of the issue: 3, 4, 5?

For bullet point 5, specify where user can locate mountpoint configuration, I see you updated mountpoint for default aggregation, but it needs to be updated also in status-grouped and average scorecards. To simplify, we could only specify where to locate mountpoints in text (should be under scorecard mountpoints key) and link to 1 full example in 9.4. Configure portfolio health on a customizable home page for customizable homepage and
9.5. Configure portfolio health on a read-only home page for read only homepage. This will be useful also for bullet point 3 of the jira ticket, to specify that mountpoint examples for defautl scorecard aggregation, status grouped and average aggregation are only showing how to configue it for read-only homepage and customizable homepage can be found in 9.4.

@sonarqubecloud

Copy link
Copy Markdown

@rh-tokeefe
rh-tokeefe changed the base branch from main to release-1.10 July 28, 2026 14:30
@rhdh-bot

Copy link
Copy Markdown
Collaborator

Shellcheck Analysis Results

Changed shell scripts in this PR: 1

Scripts analyzed:

  • modules/extend_dynamic-plugins-reference/rhdh-supported-plugins.sh

Check the Files changed tab for detailed shellcheck suggestions.

All findings are reported as warnings and won't block the PR.


Automated shellcheck analysis • See shellcheck.net for details

Comment thread artifacts/snip-tag-for-OCI-package-paths.adoc Outdated

@Gerry-Forde Gerry-Forde left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@rh-tokeefe LGTM but I left a couple of suggestions, please review and let me know what you think.

rh-tokeefe and others added 16 commits July 30, 2026 14:27
…metric-ids

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…e type clarification

- Clarify mountpoint location in all three aggregation card procedures
- Add notes indicating examples show read-only homepage configuration
- Link to sections 9.4 and 9.5 for customizable and read-only homepage examples
- Apply changes consistently across default, status-grouped, and average aggregation cards

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Changed the two steps for finding Backstage and plugin versions from
numbered list items to lettered sub-steps, which will render more cleanly
as nested instructions under the tag parameter definition.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sonarqubecloud

Copy link
Copy Markdown

@deerskindoll deerskindoll left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

@deerskindoll
deerskindoll merged commit 46aa032 into redhat-developer:release-1.10 Jul 30, 2026
6 checks passed

This branch was previously deployed

1 inactive deployment
internal — eefe8050 Deployed Jul 30, 2026 by rh-tokeefe via authorize #10981
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants