docs: add platform specific installation guide for RedHat OpenShift#775
Open
NomadXD wants to merge 2 commits into
Open
docs: add platform specific installation guide for RedHat OpenShift#775NomadXD wants to merge 2 commits into
NomadXD wants to merge 2 commits into
Conversation
Signed-off-by: Lahiru De Silva <lahirude@wso2.com>
Signed-off-by: Lahiru De Silva <lahirude@wso2.com>
Contributor
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdds a platform-specific documentation section for OpenShift, covering prerequisites, infrastructure, OpenChoreo plane installation, verification, optional workflow and observability planes, limitations, and sidebar navigation. ChangesOpenShift Platform Guide
Estimated code review effort: 4 (Complex) | ~60 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/getting-started/try-it-out/enterprise/openshift.mdx`:
- Around line 1-5: Run Prettier with --write on
docs/getting-started/try-it-out/enterprise/openshift.mdx (lines 1-5) and
docs/getting-started/try-it-out/enterprise/index.mdx (lines 1-5), correcting
table/code-fence spacing and line wrapping so both files pass the docs Prettier
check.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 873662f6-3c9b-46fb-987e-132dbbfbb219
⛔ Files ignored due to path filters (3)
versioned_docs/version-v1.1.x/getting-started/try-it-out/enterprise/index.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.1.x/getting-started/try-it-out/enterprise/openshift.mdxis excluded by!versioned_docs/**versioned_sidebars/version-v1.1.x-sidebars.jsonis excluded by!versioned_sidebars/**
📒 Files selected for processing (3)
docs/getting-started/try-it-out/enterprise/index.mdxdocs/getting-started/try-it-out/enterprise/openshift.mdxsidebars.ts
Comment on lines
+1
to
+5
| --- | ||
| title: Red Hat OpenShift | ||
| description: Install OpenChoreo's Control, Data, Workflow, and Observability planes on an existing Red Hat OpenShift cluster, with the OpenShift-specific workarounds for SCC, Gateway API CRDs, and DNS built into every step. | ||
| sidebar_position: 1 | ||
| --- |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Prettier check is failing for both new docs. The CI step prettier --check docs/**/*.{md,mdx} reports formatting issues in these files; run Prettier to fix and unblock the pipeline.
docs/getting-started/try-it-out/enterprise/openshift.mdx#L1-L5: runnpx prettier --writeon this file (check table/code-fence spacing and line wrapping).docs/getting-started/try-it-out/enterprise/index.mdx#L1-L5: runnpx prettier --writeon this file (the supported-platforms table at L17-L19 is a likely culprit).
🧰 Tools
🪛 GitHub Actions: Test deployment / 0_Test deployment.txt
[warning] 1-1: Prettier --check reported a formatting/style issue in this file.
🪛 GitHub Actions: Test deployment / Test deployment
[warning] 1-1: Prettier formatting check reported a code style issue. (prettier --check docs/**/*.{md,mdx})
📍 Affects 2 files
docs/getting-started/try-it-out/enterprise/openshift.mdx#L1-L5(this comment)docs/getting-started/try-it-out/enterprise/index.mdx#L1-L5
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/getting-started/try-it-out/enterprise/openshift.mdx` around lines 1 - 5,
Run Prettier with --write on
docs/getting-started/try-it-out/enterprise/openshift.mdx (lines 1-5) and
docs/getting-started/try-it-out/enterprise/index.mdx (lines 1-5), correcting
table/code-fence spacing and line wrapping so both files pass the docs Prettier
check.
Source: Pipeline failures
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This PR adds a platform specific section for the OpenChoreo installation guide with a guide for OpenShift installation.
Related Issues
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors