kubeflow/sdk

docs: Improve Spark documentation navigation and structure to align with other Kubeflow SDK components

Open

#618 opened on Jul 19, 2026

View on GitHubContributor guide
 (7 comments) (1 reaction) (1 assignee)Python (196 forks)auto 404
area/sparkgood first issuehelp wantedkind/feature

Repository metrics

Stars
 (124 stars)
PR merge metrics
 (PR metrics pending)

Description

What would you like to be added?

The goal of this issue is to improve the Spark documentation by restructuring it into multiple sections, similar to the Trainer and Optimizer documentation.

Potential improvements include:

  • Add a Example section.
  • Split the documentation into dedicated guides instead of a single page.
  • Improve the current documentation

This issue can be implemented through multiple documentation PRs.

Why is this needed?

The Spark documentation currently consists of a single navigation entry, making it difficult to discover features and navigate as the SDK grows.

Trainer and Optimizer already provide a structured documentation experience with dedicated sections and guides. Aligning the Spark documentation with that structure will improve discoverability, onboarding, and overall consistency across the Kubeflow SDK documentation.

Contributor guide

Research direction
Examine the Trainer and Optimizer documentation structure in the Kubeflow SDK repository, then apply a similar section based structure to the Spark documentation. Consider adding example sections and splitting the current single page into dedicated guides.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Documentation writingMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90