Uploaded image for project: 'RH Developer Hub Planning'
  1. RH Developer Hub Planning
  2. RHDHPLAN-922

RN: Deprecation of Global Floating Action Button

Create Doc EPIC from R...Prepare for Y ReleasePrepare for Z ReleasePrepare Test Plan (Y R...XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • Hide
      = Global Floating Action Button plugin is deprecated

      The Global Floating Action Button plugin (`@red-hat-developer-hub/backstage-plugin-global-floating-action-button`) is deprecated and might be removed in a future release. You can use the *Quick links* feature in the global header instead. To avoid future errors, remove or disable the plugin package and its associated configuration from your `dynamic-plugins.yaml` and `app-config.yaml` files. For more information about configuring the alternative feature, see {customizing-book-link}l#enabling-quicklinks-starred-items-upgrade_configuring-the-global-header-in-rhdh[Enabling Quicklinks and Starred Items after an upgrade].
      Show
      = Global Floating Action Button plugin is deprecated The Global Floating Action Button plugin (`@red-hat-developer-hub/backstage-plugin-global-floating-action-button`) is deprecated and might be removed in a future release. You can use the *Quick links* feature in the global header instead. To avoid future errors, remove or disable the plugin package and its associated configuration from your `dynamic-plugins.yaml` and `app-config.yaml` files. For more information about configuring the alternative feature, see {customizing-book-link}l#enabling-quicklinks-starred-items-upgrade_configuring-the-global-header-in-rhdh[Enabling Quicklinks and Starred Items after an upgrade].
    • Deprecated Functionality
    • S
    • Done

      Feature Overview

      This feature covers the formal issuance of a deprecation notice for the Global Floating Action Button plugin (@red-hat-developer-hub/backstage-plugin-global-floating-action-button) in the upcoming Red Hat Developer Hub release notes. The goal is to inform Platform Engineers and Administrators of the plugin's pending removal to prevent future compatibility issues.

      User Story

      As an RHDH Administrator,
      So that I can maintain a stable and supported developer portal environment,
      I need to be clearly informed via release notes that the Global Floating Action Button plugin is deprecated so that I can plan to remove it from my configuration.

      Goals (Expected User Outcomes)

      Awareness: Administrators are made aware that global-floating-action-button is no longer supported.

      Proactive Maintenance: Users cease new implementations of this plugin.

      Risk Mitigation: Existing users are given lead time to remove the dependency before the code is permanently deleted in a future major release.

      Requirements (Acceptance Criteria)

      AC1: Release Notes Entry

      Given the release of the next version of Red Hat Developer Hub,

      When a user accesses the "Release Notes" or "Changelog" section,

      Then there must be a visible entry under a "Deprecations" or "Breaking Changes" header stating: "The Global Floating Action Button plugin (@red-hat-developer-hub/backstage-plugin-global-floating-action-button) is deprecated and will be removed in a future release."

      AC2: Migration/Removal Advice

      Given the deprecation notice is present,

      When the user reads the notice,

      Then it should include a brief instruction to remove the plugin package and associated configuration from the app-config.yaml to avoid future errors.

      Out of Scope

      Removal of the actual plugin code from the repository (scheduled for a later sprint).

      Development of an automated migration script to remove the button.

      Creation of a direct UI replacement for the Floating Action Button.

      Customer Considerations

      Target Audience: Platform Engineers and Administrators managing RHDH instances.

      Impact: This plugin is UI-centric. Customers who rely heavily on this button for navigation or quick actions will need to be directed toward using the Quick links feature available in the global header.

      Documentation Considerations

      Release Notes: The primary deliverable is the text for the release notes. Customers who rely heavily on this button for navigation or quick actions will need to be directed toward using the Quick links feature available in the global header. The floating action button is being deprecated to make way for the new "Lightspeed AI" button that will give users quick access to the Lightspeed virtual assistant GUI.

      Upstream Documentation: A "Deprecated" badge or note should be added to the plugin's README file in the repository to warn new users against installing it.

              rhn-support-jmagak Judith Amondi Magak
              rh-ee-bwilcock Ben Wilcock
              RHDH Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: