Skip to content

RHIDP-15515: [Agentic] Agent-friendly CLI for Backstage (DP) - #2603

Merged
deerskindoll merged 1 commit into
redhat-developer:release-2.1from
jmagak:RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage
Sep 18, 2026
Merged

RHIDP-15515: [Agentic] Agent-friendly CLI for Backstage (DP)#2603
deerskindoll merged 1 commit into
redhat-developer:release-2.1from
jmagak:RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage

Conversation

@jmagak

@jmagak jmagak commented Sep 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

@rhdh-bot

rhdh-bot commented Sep 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 37/37 titles | 105s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2603/

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-14b: Inbound link stability (no ID changes for existing files)
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features
  • CQA-jtbd-01: Verify navigation file structure
  • CQA-jtbd-02: Modules not yet in product_product (informational)

Summary

Checks: 22 total, 22 pass, 0 fail

Modules not yet in product_product

18 modules (proc, con, ref) are not yet included in the product_product title.

modules/shared/ (15)
  • modules/shared/con-about-the-rhdh-cli.adoc
  • modules/shared/con-permission-based-ui-visibility-for-a-cleaner-user-experience.adoc
  • modules/shared/con-permission-types-for-rbac-ui-visibility-control.adoc
  • modules/shared/con-unsupported-scenarios-and-constraints-for-rbac-ui-visibility.adoc
  • modules/shared/con-user-experience-and-security-benefits-of-rbac-ui-hiding.adoc
  • modules/shared/proc-authenticating-and-registering-action-sources-for-the-rhdh-cli.adoc
  • modules/shared/proc-configure-rate-limits-for-lightspeed.adoc
  • modules/shared/proc-configure-rbac-visibility-rules-to-hide-unauthorized-ui-elements.adoc
  • modules/shared/proc-configuring-rhdh-for-the-rhdh-cli.adoc
  • modules/shared/proc-installing-the-rhdh-cli.adoc
  • modules/shared/ref-ai-feature-permissions.adoc
  • modules/shared/ref-permission-evaluation-behavior-for-ui-visibility.adoc
  • modules/shared/ref-plugin-permissions-for-ui-visibility.adoc
  • modules/shared/ref-rhdh-cli-commands-overview.adoc
  • modules/shared/ref-ui-elements-with-rbac-visibility-control.adoc
modules/upgrade_upgrade-rhdh/ (3)
  • modules/upgrade_upgrade-rhdh/con-rhdh-upgrade-helper-skill.adoc
  • modules/upgrade_upgrade-rhdh/proc-run-the-rhdh-upgrade-helper-skill.adoc
  • modules/upgrade_upgrade-rhdh/ref-rhdh-upgrade-helper-skill-configuration-inputs.adoc

22 checks: 22 pass, 0 fail

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

Updated 2026-09-17 16:25:14 UTC

@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from 4157fdd to f26d77a Compare September 15, 2026 05:34
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from f26d77a to bd1af2d Compare September 15, 2026 06:01
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from bd1af2d to 23a5fc6 Compare September 15, 2026 15:22
yangcao77
yangcao77 reviewed Sep 15, 2026
View reviewed changes
Comment thread modules/shared/proc-configuring-rhdh-for-the-rhdh-cli.adoc Outdated
yangcao77
yangcao77 reviewed Sep 15, 2026
View reviewed changes
Comment thread modules/shared/proc-configuring-rhdh-for-the-rhdh-cli.adoc Outdated
yangcao77
yangcao77 reviewed Sep 15, 2026
View reviewed changes
Comment thread modules/shared/proc-configuring-rhdh-for-the-rhdh-cli.adoc
yangcao77
yangcao77 reviewed Sep 15, 2026
View reviewed changes
Comment thread modules/shared/proc-configuring-rhdh-for-the-rhdh-cli.adoc Outdated
yangcao77
yangcao77 reviewed Sep 15, 2026
View reviewed changes
Comment thread modules/shared/ref-rhdh-cli-commands-overview.adoc
yangcao77
yangcao77 reviewed Sep 15, 2026
View reviewed changes
Comment thread modules/shared/con-about-the-rhdh-cli.adoc Outdated
yangcao77
yangcao77 reviewed Sep 15, 2026
View reviewed changes
Comment thread modules/shared/ref-rhdh-cli-commands-overview.adoc Outdated
yangcao77
yangcao77 suggested changes Sep 15, 2026
View reviewed changes

@yangcao77 yangcao77 left a comment •
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

left some comments.

in addition, I would recommand to restructure / reword the docs, as rhdh-cli itself contains not just the intent based commands.
the docs currently only covers intent-based commands for querying and managing RHDH catalog entities, TechDocs content, and software templates. it's not the full feature set of the rhdh-cli.
either limit the scope to only intent-based command groups for querying and managing RHDH through Backstage actions. or bundle every other rhdh-cli related docs together.

@jmagak

jmagak commented Sep 16, 2026

Copy link
Copy Markdown
Member Author

either limit the scope to only intent-based command groups for querying and managing RHDH through Backstage actions.

Thanks @yangcao77 — all comments addressed and scoped the docs to the intent-based commands. PTAL.

@jmagak
jmagak requested a review from yangcao77 September 16, 2026 07:52
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from c5829f3 to deee5c6 Compare September 16, 2026 14:23
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from deee5c6 to e97bebd Compare September 16, 2026 14:29
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from e97bebd to 7ebe0bb Compare September 16, 2026 15:09
yangcao77
yangcao77 reviewed Sep 17, 2026
View reviewed changes
Comment thread modules/shared/con-about-the-rhdh-cli.adoc Outdated
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from 32cfd79 to e9d0a7b Compare September 17, 2026 08:54
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from e9d0a7b to 2418dad Compare September 17, 2026 10:39
pabel-rh
pabel-rh reviewed Sep 17, 2026
View reviewed changes
Comment thread modules/shared/con-about-the-rhdh-cli.adoc Outdated
Comment thread modules/shared/con-about-the-rhdh-cli.adoc Outdated
Comment thread modules/shared/con-about-the-rhdh-cli.adoc Outdated
Comment thread modules/shared/con-about-the-rhdh-cli.adoc Outdated
Comment thread modules/shared/con-about-the-rhdh-cli.adoc Outdated
Comment thread modules/shared/proc-authenticating-and-registering-action-sources-for-the-rhdh-cli.adoc Outdated
Comment thread modules/shared/proc-authenticating-and-registering-action-sources-for-the-rhdh-cli.adoc Outdated
Comment thread modules/shared/proc-authenticating-and-registering-action-sources-for-the-rhdh-cli.adoc Outdated
Comment thread modules/shared/proc-configuring-rhdh-for-the-rhdh-cli.adoc Outdated
Comment thread modules/shared/ref-rhdh-cli-commands-overview.adoc Outdated
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from 2418dad to 5676182 Compare September 17, 2026 12:23
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from 5676182 to a87f103 Compare September 17, 2026 12:40
@jmagak

jmagak commented Sep 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

/hold

@jmagak

jmagak commented Sep 17, 2026

Copy link
Copy Markdown
Member Author

Placing this on hold until redhat-developer/rhdh-cli#211 is merged. cc @yangcao77

yangcao77
yangcao77 approved these changes Sep 17, 2026
View reviewed changes

@yangcao77 yangcao77 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.

LGTM. the PR to update the rhdh-cli version has been merged

@jmagak jmagak added Ready to merge 💂 AEM ready to merge PR content is ready to be migrated to AEM and removed do-not-merge/hold labels Sep 17, 2026
@jmagak
jmagak force-pushed the RHIDP-15515-Agentic-Agent-friendly-CLI-for-Backstage branch from a87f103 to b6c99e4 Compare September 17, 2026 16:21
@sonarqubecloud

sonarqubecloud Bot commented Sep 17, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@deerskindoll
deerskindoll merged commit 31b70cc into redhat-developer:release-2.1 Sep 18, 2026
6 checks passed

This branch was successfully deployed

1 active deployment
internal — b6c99e40 Deployed Sep 17, 2026 by jmagak via authorize #11287
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pabel-rh pabel-rh pabel-rh approved these changes
+1 more reviewer
@yangcao77 yangcao77 yangcao77 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

AEM ready to merge PR content is ready to be migrated to AEM Peer review done 📘 Ready to merge 💂 Technical review done ⛅ Any procedure has been succesfully tested

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@jmagak @rhdh-bot @yangcao77 @pabel-rh @deerskindoll