Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP|docs: Fix instructions of valid OCP platform types #150

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mtulio
Copy link
Contributor

@mtulio mtulio commented Mar 3, 2025

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, use fixes #<issue_number>(, fixes #<issue_number>, ...) format, where issue_number might be a GitHub issue, or a Jira story:
Fixes #

Checklist

  • Subject and description added to both, commit and PR.
  • Relevant issues have been referenced.
  • This change includes docs.
  • This change includes unit tests.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 3, 2025
Copy link

openshift-ci bot commented Mar 3, 2025

[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 ask for approval from mtulio. For more information see the Code Review Process.

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

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

@mtulio mtulio force-pushed the docs-valid-guide-plat-type branch from 33c94e8 to e4fde45 Compare March 3, 2025 17:12
@mtulio mtulio changed the title docs: Fix instructions of valid OCP platform types WIP|docs: Fix instructions of valid OCP platform types Mar 3, 2025
@mtulio mtulio requested a review from Copilot March 6, 2025 21:50

Choose a reason for hiding this comment

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

PR Overview

This PR updates the cluster validation documentation to fix and clarify instructions for valid OpenShift platform types.

  • Updated table structure with three columns: Platform Type, Installation method, and Documentation.
  • Added rows for distinct installation methods and documentation links.
  • Included a note clarifying when to use the 'None' platform type.

Reviewed Changes

File Description
docs/guides/cluster-validation/index.md Updated table format and clarified usage of platform types.

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

docs/guides/cluster-validation/index.md:101

  • [nitpick] Consider rephrasing this note for clarity and consistency. For example, use 'Platform type None should only be used in clusters installed with Assisted Installer using the User-Managed networking mode when required; otherwise, use platform type External.'
*platform type `None` should be used only in clusters installed with Assisted Installer  with `User-managed` networking mode only when it is required, otherwise use options with platform type `External`.

docs/guides/cluster-validation/index.md:99

  • [nitpick] The 'External' platform type appears twice with different installation methods. Consider clarifying or differentiating these entries to reduce potential confusion.
| `External`    | Agent Based Installer | [OpenShift Product][abi-external] |
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant