Skip to content

docs: minor cleanups in deployment README#131

Merged
jland-redhat merged 1 commit intoopendatahub-io:mainfrom
bartoszmajsak:docs/deployment/readme
Oct 2, 2025
Merged

docs: minor cleanups in deployment README#131
jland-redhat merged 1 commit intoopendatahub-io:mainfrom
bartoszmajsak:docs/deployment/readme

Conversation

@bartoszmajsak
Copy link
Copy Markdown
Collaborator

@bartoszmajsak bartoszmajsak commented Oct 2, 2025

  • Removes k8s section to avoid confusion, as it's not fully tested
  • Switches to use kustomize instead of kubectl -k. The latter might be behind required version

Summary by CodeRabbit

  • Documentation
    • Simplified deployment commands by using kustomize build piped to kubectl apply and introducing a PROJECT_DIR variable.
    • Removed Kubernetes Ingress and Storage Initializer sections to streamline the guide.
    • Updated and reorganized deployment instructions to reference docs/samples/model paths instead of legacy locations.
    • Clarified model deployment examples for Simulator, OPT-125M, and Qwen3.

- removes k8s section
- Switches to use kustomize instead of kubectl -k. The latter might be behind required version

Signed-off-by: Bartosz Majsak <bartosz.majsak@gmail.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 2, 2025

Walkthrough

Documentation updates in deployment/README.md: switched kubectl examples to use PROJECT_DIR and kustomize build piping, pointed paths to docs/samples/model, and removed sections covering Kubernetes Ingress and Storage Initializer configuration.

Changes

Cohort / File(s) Summary of Changes
Deployment docs refresh
deployment/README.md
Updated deployment commands to PROJECT_DIR=$(git rev-parse --show-toplevel) and `kustomize build ...

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my ears at YAML’s tune,
Kustomize pipes hum soft as moon.
Ingress gone, the path made clear,
Samples mapped from far to near.
With a hop, deploy I dare—
Git-top roots the tidy lair.
Thump! Ship shape, everywhere.

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title “docs: minor cleanups in deployment README” accurately indicates that documentation was edited but is too generic to convey the specific removal of the Kubernetes section and the switch from kubectl -k to kustomize commands. It does not mislead about the changeset but fails to highlight the primary alterations in a meaningful way. Consider revising the title to more explicitly mention the key updates, for example: “docs: remove Kubernetes section and use kustomize instead of kubectl -k in deployment README.”
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 13d6da9 and a816b54.

📒 Files selected for processing (1)
  • deployment/README.md (2 hunks)

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.

❤️ Share

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

@jland-redhat jland-redhat merged commit 870bbff into opendatahub-io:main Oct 2, 2025
2 checks passed
@bartoszmajsak bartoszmajsak deleted the docs/deployment/readme branch October 2, 2025 21:16
SB159 pushed a commit to SB159/maas-billing that referenced this pull request Oct 15, 2025
- removes k8s section
- Switches to use kustomize instead of kubectl -k. The latter might be behind required version

Signed-off-by: Bartosz Majsak <bartosz.majsak@gmail.com>
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.

3 participants