Skip to content

RHIDP-13914: Update RHDH documentation for removal of 'global-floating-action-button' plugin#2463

Open
jmagak wants to merge 2 commits into
redhat-developer:mainfrom
jmagak:RHIDP-13914-Update-RHDH-documentation-for-removal-of-global-floating-action-button-plugin
Open

RHIDP-13914: Update RHDH documentation for removal of 'global-floating-action-button' plugin#2463
jmagak wants to merge 2 commits into
redhat-developer:mainfrom
jmagak:RHIDP-13914-Update-RHDH-documentation-for-removal-of-global-floating-action-button-plugin

Conversation

@jmagak

@jmagak jmagak commented Jul 3, 2026

Copy link
Copy Markdown
Member

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

Version(s): 2.1.0, main

Issue: RHIDP-15246

Preview:

@rhdh-bot

rhdh-bot commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 36/36 titles | 104s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2463/


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

22 checks: 22 pass, 0 fail

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


Updated 2026-07-07 17:08:57 UTC

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

Thanks for the PR 👏

Looking at the changes, the PR is over-aggressively replacing "floating action button (FAB)" with just "button" across the documentation. This creates ambiguity in files related to Lightspeed:

  • con-chat-assistance-with.adoc — Changes "FAB" to "button" but warns about conflicting buttons. The context is actually about the Lightspeed button, not the removed plugin.
  • proc-configure-by-using-the-helm-chart.adoc, proc-manage-chats.adoc, etc. — All Lightspeed verification steps use generic "button" language, losing clarity about what component is actually being discussed.

What Should Happen
The documentation should distinguish:

  • Old FAB plugin references → Remove or replace appropriately
  • Lightspeed button references → Keep specific terminology (e.g., "Lightspeed button" or describe it as "the button provided by the Lightspeed plugin") to avoid confusion, especially in the warning about conflicting buttons

Comment thread modules/shared/con-chat-assistance-with.adoc Outdated
@jmagak jmagak force-pushed the RHIDP-13914-Update-RHDH-documentation-for-removal-of-global-floating-action-button-plugin branch from 9ca14f5 to e72563f Compare July 6, 2026 19:55
@jmagak jmagak requested a review from ciiay July 6, 2026 20:01

@ciiay ciiay 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

Thanks for the updates 🤝

@openshift-ci openshift-ci Bot added the lgtm label Jul 7, 2026
@jmagak jmagak force-pushed the RHIDP-13914-Update-RHDH-documentation-for-removal-of-global-floating-action-button-plugin branch from cbf9794 to 73c65ed Compare July 7, 2026 17:00
@openshift-ci

openshift-ci Bot commented Jul 7, 2026

Copy link
Copy Markdown

New changes are detected. LGTM label has been removed.

@openshift-ci openshift-ci Bot removed the lgtm label Jul 7, 2026
@sonarqubecloud

sonarqubecloud Bot commented Jul 7, 2026

Copy link
Copy Markdown

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.

3 participants