Skip to content

Update Inventory Upload docs link for new Insights chapter#1222

Merged
nofaralfasi merged 3 commits into
theforeman:developfrom
nofaralfasi:SAT-43927-ref
Jul 1, 2026
Merged

Update Inventory Upload docs link for new Insights chapter#1222
nofaralfasi merged 3 commits into
theforeman:developfrom
nofaralfasi:SAT-43927-ref

Conversation

@nofaralfasi

Copy link
Copy Markdown
Collaborator

Switch getInventoryDocsUrl to the new documentation location in Administering_Project (configuring-project-server-for-cloud-connection) and update the helper unit test to assert the new guide/chapter mapping.

What are the changes introduced in this pull request?

  • Updated the Inventory Upload documentation target in getInventoryDocsUrl() to use the new docs location introduced by the docs team changes.
  • Switched the docs mapping from: Managing_Hosts + configuring-foreman-server-for-cloud-connection to: Administering_Project + configuring-project-server-for-cloud-connection
  • Updated the unit test in webpack/ForemanInventoryUpload/__tests__/ForemanInventoryHelpers.test.js to assert the new guide/chapter mapping.

Considerations taken when implementing this change?

  • This is a follow-up update to foreman_rh_cloud#1207.
  • The update is required because documentation structure/chapter IDs are changing in foreman-documentation#4882.
  • Used getDocsURL(...) (not a hardcoded external URL) so the link continues to go through Foreman’s docs-linking mechanism and downstream branding/mapping.
  • Aligned the chapter identifier with the new documentation structure from the docs PR, so the WebUI link does not break when the old chapter path changes.
  • Kept the change minimal and scoped only to the Inventory Upload docs helper and its related test.

What are the testing steps for this pull request?

  • Run the unit test:
    npm test -- --testPathPattern="ForemanInventoryHelpers" --watchAll=false
  • Verify it passes and confirms getDocsURL is called with:
    Administering_Project
    configuring-project-server-for-cloud-connection
  • Manual UI verification:
    • Open WebUI → Red Hat Lightspeed → Inventory Upload.
    • Open the kebab menu (three dots) → click Documentation.
    • Verify it opens the expected Admin guide chapter (cloud connection section) and does not return 404.

Switch `getInventoryDocsUrl` to the new documentation location in
`Administering_Project` (`configuring-project-server-for-cloud-connection`)
and update the helper unit test to assert the new guide/chapter mapping.

@sourcery-ai sourcery-ai Bot 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.

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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread webpack/ForemanInventoryUpload/__tests__/ForemanInventoryHelpers.test.js Outdated
Comment thread webpack/ForemanInventoryUpload/ForemanInventoryHelpers.js Outdated
Co-authored-by: Lena Ansorge <zuansorg@redhat.com>

@Lennonka Lennonka left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@nofaralfasi nofaralfasi merged commit 9a7a786 into theforeman:develop Jul 1, 2026
17 of 18 checks passed
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