Skip to content

fix(RHINENG-22270): Fix broken url links#422

Open
hugohezel wants to merge 1 commit intoRedHatInsights:mainfrom
hugohezel:hhezel/RHINENG-22270
Open

fix(RHINENG-22270): Fix broken url links#422
hugohezel wants to merge 1 commit intoRedHatInsights:mainfrom
hugohezel:hhezel/RHINENG-22270

Conversation

@hugohezel
Copy link

@hugohezel hugohezel commented Dec 17, 2025

Summary by Sourcery

Update quickstart documentation links to point to current Red Hat Lightspeed and RHEL conversion resources.

Bug Fixes:

  • Correct broken or outdated documentation URLs in multiple Insights and Lightspeed quickstart YAML definitions.

Documentation:

  • Refresh links in quickstart docs for conversion, pre-conversion analysis, remediation plans, image builder, vulnerability assessment, and task usage to reference the latest relevant guides.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 17, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR updates several quickstart YAML docs to point broken or outdated documentation URLs to their new, correct Red Hat docs locations, keeping link text and surrounding instructional content otherwise unchanged.

Flow diagram for quickstarts linking to updated documentation URLs

flowchart LR
  subgraph Quickstarts
    Q1["Pre_conversion_quickstart"]
    Q2["Conversion_quickstart"]
    Q3["Remediation_plan_quickstart"]
    Q4["Image_builder_quickstart"]
    Q5["OpenShift_vulnerability_quickstart"]
  end

  subgraph Docs
    D1["RHEL_conversion_prep_in_Lightspeed_docs"]
    D2["Convert2rhel_Lightspeed_conversion_docs"]
    D3["Remediation_plan_creation_docs"]
    D4["Execution_and_playbook_docs"]
    D5["Hybrid_cloud_deployment_docs"]
    D6["OpenShift_cluster_vulnerability_docs_in_Lightspeed"]
  end

  Q1 --> D1
  Q2 --> D2
  Q2 --> D1
  Q3 --> D3
  Q3 --> D4
  Q4 --> D5
  Q5 --> D6
Loading

File-Level Changes

Change Details Files
Update RHEL conversion preparation links in conversion-related quickstarts to new Convert2RHEL / Lightspeed documentation locations.
  • Replace the pre-conversion preparation URL for converting CentOS Linux 7 to RHEL 7 with the new Convert2RHEL Lightspeed path.
  • Update the follow-up troubleshooting bullet link that references preparation steps for a conversion using Red Hat Lightspeed to the new Convert2RHEL Lightspeed URL.
  • In the pre-conversion analysis quickstart, change the preparation steps link to the Lightspeed-specific conversion preparation documentation URL.
docs/quickstarts/insights-tasks-conversion/insights-tasks-conversion.yml
docs/quickstarts/insights-tasks-pre-conversion/insights-tasks-pre-conversion.yml
Update tasks documentation links from old single-page or incorrect paths to the new Lightspeed tasks docs structure.
  • Change references to the "assessing_and_remediating_system_issues_using_red_hat_lightspeed_tasks" doc from html-single paths (and with anchors like #doc-wrapper) to the new html multi-page "assessing_and_remediating_system_issues_by_using_red_hat_lightspeed_tasks" path.
  • Ensure the same tasks documentation URL is used consistently across conversion and upgrade quickstarts.
docs/quickstarts/insights-tasks-conversion/insights-tasks-conversion.yml
docs/quickstarts/insights-tasks-pre-conversion/insights-tasks-pre-conversion.yml
docs/quickstarts/insights-tasks-upgrade8to9/insights-tasks-upgrade8to9.yml
Update remediation plan and execution help links to the appropriate sections of the current Red Hat Lightspeed remediations guide.
  • Adjust the remediation plan creation help link to the "creating-remediation-plans" section in the remediations guide instead of the older FedRAMP-specific or playbook-focused path.
  • Update the execution readiness help link from a generic playbook management URL to the specific "executing-remediation-playbooks" section with an anchor for executing playbooks from Insights.
docs/quickstarts/insights-remediate-plan-create/insights-remediate-plan-create.yml
Point Image Builder quickstart link to the broader hybrid clouds deployment and management documentation.
  • Replace the Image Builder documentation link that referenced only creating customized images with one that targets the updated "deploying_and_managing_rhel_systems_in_hybrid_clouds" documentation, which now covers Image Builder usage.
docs/quickstarts/insights-image-builder/insights-image-builder.yml
Update OpenShift vulnerability quickstart link to the Lightspeed-branded OpenShift vulnerability assessment documentation.
  • Change the vulnerability service link from the older "red_hat_insights_for_openshift" html-single path to the new Lightspeed documentation path for assessing security vulnerabilities in OpenShift clusters using Red Hat Lightspeed.
docs/quickstarts/openshift-insights-vulnerability/openshift-insights-vulnerability.yml

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • In insights-tasks-conversion.yml, the link text [prepare for a conversion using Red Hat Lightspeed.] (https://...) still has a space between the ] and (, which may prevent it from rendering as a proper link in some markdown parsers; consider removing that space while you're updating the URL.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In `insights-tasks-conversion.yml`, the link text `[prepare for a conversion using Red Hat Lightspeed.] (https://...)` still has a space between the `]` and `(`, which may prevent it from rendering as a proper link in some markdown parsers; consider removing that space while you're updating the URL.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant