feat(docs): add local development guide#318
feat(docs): add local development guide#318sohaa-khan11 wants to merge 3 commits intokubeflow:mainfrom
Conversation
|
🎉 Welcome to the Kubeflow SDK! 🎉 Thanks for opening your first PR! We're happy to have you as part of our community 🚀 Here's what happens next:
Join the community:
Feel free to ask questions in the comments if you need any help or clarification! |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Pull request overview
Adds a new Local Development Guide to the Kubeflow SDK docs to centralize guidance on running training locally (process/container) and transitioning to Kubernetes, and links it from the main docs navigation and Getting Started page.
Changes:
- Added a new
local-development-guide.mdpage covering backend options, switching, an end-to-end example, and troubleshooting. - Updated the main docs toctree to include the new guide.
- Added a “Local Development” card to the Getting Started landing page.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/source/local-development-guide.md | Introduces the new local development guide content and examples. |
| docs/source/index.rst | Adds the new guide into the main docs navigation (toctree). |
| docs/source/getting-started/index.rst | Adds a “Local Development” navigation card pointing to the new guide. |
Signed-off-by: Soha khan <soharida2005@gmail.com>
8948c11 to
523250c
Compare
… kubernetes section Signed-off-by: Soha khan <soharida2005@gmail.com>
Signed-off-by: Soha khan <soharida2005@gmail.com>
What this PR does / why we need it:
Adds a comprehensive Local Development Guide to the Kubeflow SDK documentation.
The current documentation briefly mentions local backends but does not provide a centralized, practical guide covering:
This PR introduces a structured guide to improve developer onboarding and local development clarity.
The documentation was carefully reviewed and validated against the current SDK APIs. All examples were verified manually.
Which issue(s) this PR fixes (optional, in
Fixes #<issue number>, #<issue number>, ...format, will close the issue(s) when PR gets merged):Fixes #259
Checklist: