Skip to content

feat(docs): add local development guide#318

Open
sohaa-khan11 wants to merge 3 commits intokubeflow:mainfrom
sohaa-khan11:docs/local-development-guide
Open

feat(docs): add local development guide#318
sohaa-khan11 wants to merge 3 commits intokubeflow:mainfrom
sohaa-khan11:docs/local-development-guide

Conversation

@sohaa-khan11
Copy link

@sohaa-khan11 sohaa-khan11 commented Feb 23, 2026

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:

  1. Backend comparison (Local Process, Docker, Podman, Kubernetes)
  2. Switching between backends
  3. Complete runnable training example
  4. Debugging and troubleshooting guidance
  5. Runtime configuration details
  6. Recommended development workflow

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:

  • Docs included if any changes are user facing

Copilot AI review requested due to automatic review settings February 23, 2026 12:19
@github-actions
Copy link
Contributor

🎉 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:

  • If you haven't already, please check out our Contributing Guide for repo-specific guidelines and the Kubeflow Contributor Guide for general community standards
  • Our team will review your PR soon! cc @kubeflow/kubeflow-sdk-team

Join the community:

Feel free to ask questions in the comments if you need any help or clarification!
Thanks again for contributing to Kubeflow! 🙏

@google-oss-prow
Copy link
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 electronic-waste for approval. For more information see the Kubernetes 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

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.md page 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.

@sohaa-khan11 sohaa-khan11 changed the title docs: add local development guide and update navigation docs(sdk): add local development guide and update navigation Feb 23, 2026
@sohaa-khan11 sohaa-khan11 changed the title docs(sdk): add local development guide and update navigation feat(docs): add local development guide Feb 23, 2026
Signed-off-by: Soha khan <soharida2005@gmail.com>
@sohaa-khan11 sohaa-khan11 force-pushed the docs/local-development-guide branch from 8948c11 to 523250c Compare February 23, 2026 12:40
… kubernetes section

Signed-off-by: Soha khan <soharida2005@gmail.com>
Signed-off-by: Soha khan <soharida2005@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Local Development

2 participants