kubeflow/sdk

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

Aberta

#618 aberto em 19 de jul. de 2026

Ver no GitHubGuia do colaborador
 (7 comentários) (1 reação) (1 responsável)Python (196 forks)auto 404
area/sparkgood first issuehelp wantedkind/feature

Métricas do repositório

Stars
 (124 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Examine a estrutura da documentação do Trainer e Optimizer no repositório Kubeflow SDK e aplique uma estrutura baseada em seções semelhante à documentação do Spark. Considere adicionar seções de exemplo e dividir a página única atual em guias dedicadas.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Documentation writingMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90