SAT-42791 - Pass docs links through LinksController

[ofedoren]

(cherry picked from commit f2d29a0)

What are the changes introduced in this pull request?

Considerations taken when implementing this change?

What are the testing steps for this pull request?

Summary by Sourcery

Route the Subscriptions service documentation link through the centralized links controller for the Foreman inventory upload UI.

New Features:

• Expose a helper to generate the Subscriptions service documentation URL via the links controller.

Enhancements:

• Update the Subscriptions service help link in the inventory upload page description to use the centralized docs URL helper instead of a hardcoded URL.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Routes the Subscriptions service documentation link through Foreman’s LinksController by adding a helper for the docs URL and using it in the page description component instead of a hard-coded external URL.

Sequence diagram for Subscriptions service docs link via LinksController

sequenceDiagram
  actor User
  participant Browser
  participant PageDescription
  participant ForemanApp
  participant LinksController
  participant DocsSite

  User ->> Browser: Click Subscriptions service docs link
  Browser ->> PageDescription: Render component
  PageDescription ->> PageDescription: getSubscriptionServiceDocsUrl()
  PageDescription ->> Browser: Render anchor href /links/manual?root_url=encoded_docs_url
  User ->> Browser: Click rendered anchor
  Browser ->> ForemanApp: GET /links/manual?root_url=encoded_docs_url
  ForemanApp ->> LinksController: Route request
  LinksController ->> LinksController: Decode root_url and build redirect
  LinksController -->> Browser: 302 Redirect to docs.redhat.com/subscription_central
  Browser ->> DocsSite: GET docs.redhat.com/subscription_central
  DocsSite -->> Browser: 200 OK docs content
  Browser -->> User: Display Subscriptions service documentation

Loading

Class diagram for ForemanInventoryHelpers and PageDescription docs link

classDiagram
  class ForemanInventoryHelpers {
    +getInventoryDocsUrl() string
    +getSubscriptionServiceDocsUrl() string
    +getActionsHistoryUrl() string
  }

  class PageDescription {
    <<functional_component>>
    +PageDescription() ReactElement
  }

  ForemanInventoryHelpers <.. PageDescription : uses

Loading

File-Level Changes

Change	Details	Files
Introduce helper to generate Subscriptions service docs URL via LinksController and use it in the page description link.	Add getSubscriptionServiceDocsUrl helper that builds a /links/manual/ URL with the Subscriptions service docs root_url encoded Replace hard-coded Subscriptions service docs href with a call to the new helper in the PageDescription component	webpack/ForemanInventoryUpload/ForemanInventoryHelpers.js webpack/ForemanInventoryUpload/Components/PageHeader/components/PageDescription/PageDescription.js

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}