Skip to content

Rename "Insights Advisor" to "Red Hat Lightspeed Advisor" in API docs#2911

Draft
Jakub007d wants to merge 1 commit into
openshift:masterfrom
Jakub007d:advisor-rename
Draft

Rename "Insights Advisor" to "Red Hat Lightspeed Advisor" in API docs#2911
Jakub007d wants to merge 1 commit into
openshift:masterfrom
Jakub007d:advisor-rename

Conversation

@Jakub007d

Copy link
Copy Markdown

Rename all "Insights Advisor" references in API field descriptions to "Red Hat Lightspeed Advisor" across operator/v1, insights/v1, insights/v1alpha1, and insights/v1alpha2 types.
The generated swagger docs, CRD manifests, and OpenAPI specs were updated with make update.

Ref: https://redhat.atlassian.net/browse/HCCDOC-4522

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

@openshift-ci openshift-ci Bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 2, 2026
@openshift-ci

openshift-ci Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Hello @Jakub007d! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

@openshift-ci

openshift-ci Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign joelspeed for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 2, 2026
@openshift-ci

openshift-ci Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Hi @Jakub007d. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 8590eea2-78fd-49b4-ad06-6963202f26b4

📥 Commits

Reviewing files that changed from the base of the PR and between 1ebdd3d and b46ea03.

⛔ Files ignored due to path filters (13)
  • insights/v1/zz_generated.crd-manifests/0000_10_insights_01_datagathers.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
  • insights/v1/zz_generated.featuregated-crd-manifests/datagathers.insights.openshift.io/InsightsOnDemandDataGather.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • insights/v1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
  • insights/v1alpha1/zz_generated.crd-manifests/0000_10_insights_01_datagathers.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
  • insights/v1alpha1/zz_generated.featuregated-crd-manifests/datagathers.insights.openshift.io/InsightsOnDemandDataGather.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • insights/v1alpha1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
  • insights/v1alpha2/zz_generated.crd-manifests/0000_10_insights_01_datagathers.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
  • insights/v1alpha2/zz_generated.featuregated-crd-manifests/datagathers.insights.openshift.io/InsightsOnDemandDataGather.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • insights/v1alpha2/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
  • openapi/generated_openapi/zz_generated.openapi.go is excluded by !openapi/**, !**/zz_generated*
  • operator/v1/zz_generated.crd-manifests/0000_50_insights_00_insightsoperators.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
  • operator/v1/zz_generated.featuregated-crd-manifests/insightsoperators.operator.openshift.io/AAA_ungated.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • operator/v1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
📒 Files selected for processing (5)
  • insights/v1/types_insights.go
  • insights/v1alpha1/types_insights.go
  • insights/v1alpha2/types_insights.go
  • operator/v1/types_insights.go
  • payload-manifests/crds/0000_10_insights_01_datagathers.crd.yaml

📝 Walkthrough

Walkthrough

This pull request updates documentation comments across multiple Go type definition files (insights v1, v1alpha1, v1alpha2, and operator v1) and a corresponding CRD manifest file. The change replaces references to "Insights Advisor" with "Red Hat Lightspeed Advisor" in field descriptions for the AdvisorURI/advisorURI field within HealthCheck structs. No field types, JSON tags, validation rules, or struct logic are modified.

Changes

File Change Summary
insights/v1/types_insights.go Updated advisorURI doc comment wording
insights/v1alpha1/types_insights.go Updated AdvisorURI doc comment wording
insights/v1alpha2/types_insights.go Updated advisorURI doc comment wording
operator/v1/types_insights.go Updated AdvisorURI and state field doc comment wording
payload-manifests/crds/0000_10_insights_01_datagathers.crd.yaml Updated generated CRD schema description text

Sequence Diagram(s)

Not applicable; this change is limited to documentation/comment text updates with no behavioral or interaction changes.

Estimated code review effort: 1 (Low) — purely textual documentation changes with no logic, type, or validation modifications.

Related issues: None specified.

Related PRs: None specified.

Suggested labels: documentation, low-risk

Suggested reviewers: None specified.

🐰 A rabbit hopped through comments neat,
Renaming Advisor, oh so sweet,
From Insights old to Lightspeed new,
Just words rewritten, nothing to chew,
A tidy hop, a docs update complete.

🚥 Pre-merge checks | ✅ 15
✅ Passed checks (15 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: renaming API docs from Insights Advisor to Red Hat Lightspeed Advisor.
Description check ✅ Passed The description accurately matches the changed API docs, generated specs, and CRD updates across the listed packages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed The PR only changes API comments and generated docs/manifests; no Ginkgo tests or test titles are added or modified.
Test Structure And Quality ✅ Passed PR only changes comments and generated docs; no Ginkgo test files or test logic were modified, so the checklist is not applicable.
Microshift Test Compatibility ✅ Passed No new Ginkgo e2e tests were added; the changed files are doc/comment updates, and existing Ginkgo suites are envtest/unit-style with no unsupported MicroShift APIs.
Single Node Openshift (Sno) Test Compatibility ✅ Passed Changed files are comment-only type/CRD docs; no new Ginkgo tests or SNO-sensitive assumptions were added.
Topology-Aware Scheduling Compatibility ✅ Passed Only API doc/comments and generated docs changed; no replicas, affinity, nodeSelector, tolerations, or scheduling logic were introduced.
Ote Binary Stdout Contract ✅ Passed PR only changes comments/CRD text in type definitions; no main/init/TestMain/RunSpecs or stdout writes were added in process-level code.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed PR only renames API doc strings and generated specs; no Ginkgo e2e tests or networking code were added.
No-Weak-Crypto ✅ Passed Commit only renames API doc text; scanned changed files/diff found no weak-crypto terms or crypto imports.
Container-Privileges ✅ Passed Docs-only API/CRD text changes; no workload manifests or privilege settings (privileged/hostPID/hostNetwork/etc.) were present.
No-Sensitive-Data-In-Logs ✅ Passed PR only renames API field descriptions/comments; no log statements or sensitive data handling were added in touched files.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.12.2)

Error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented
The command is terminated due to an error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented


Comment @coderabbitai help to get the list of available commands.

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

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant