Jump to content

Connect SuperML | Leeroopedia MCP: Equip your AI agents with best practices, code verification, and debugging knowledge. Powered by Leeroo — building Organizational Superintelligence. Contact us at founders@leeroo.com.

Implementation:Kubeflow Kubeflow Roadmap Documentation

From Leeroopedia
Knowledge Sources
Domains Release Management, Documentation, ROADMAP
Last Updated 2026-02-13 00:00 GMT

Overview

Concrete tool for updating release documentation, provided by the ROADMAP.md file update process and kubeflow.org documentation site maintenance.

Description

The Roadmap Documentation implementation defines the specific process for updating the ROADMAP.md file in the kubeflow/kubeflow repository and coordinating updates to the kubeflow.org documentation site. The ROADMAP.md file is structured newest-first, spanning from v1.11 down to v0.6, with each release section containing a header with version and date, themes, and detailed per-WG tracking issue links. This implementation also covers the generation and compilation of component-specific release notes from sub-project repositories.

Usage

Use this implementation when:

  • A new release section needs to be prepended to ROADMAP.md
  • Themes and tracking issue links need to be documented for an upcoming release
  • The kubeflow.org documentation site needs to be updated for a new release
  • Component release notes need to be compiled into a unified summary

Code Reference

Source Location

Signature

# ROADMAP.md Update Pattern
# 1. Prepend new release section at top of file (newest-first ordering)
# 2. Include release header with version and target date
# 3. Add timeline reference link
# 4. List themes as bulleted items
# 5. Add per-WG tracking issue links under detailed features section
# 6. Submit PR for review

git checkout -b update-roadmap-vX.Y
# Edit ROADMAP.md
git add ROADMAP.md
git commit -m "Add vX.Y release to ROADMAP.md"
gh pr create --title "Update ROADMAP.md for vX.Y release"

Import

# Access the current ROADMAP.md
git clone https://github.com/kubeflow/kubeflow.git
cat kubeflow/ROADMAP.md

# Access the kubeflow.org documentation source
git clone https://github.com/kubeflow/website.git

I/O Contract

Inputs

Name Type Required Description
release_version string Yes Release version section header (e.g., Kubeflow 1.11 Release)
release_date string Yes Target or actual release date (e.g., December 2025)
themes_list list of strings Yes High-level release themes (e.g., Trainer V2.0, Model Registry new features)
per_wg_tracking_links map of string to URL Yes Per-WG tracking issue or release tag URLs for the detailed features section
timeline_reference URL Yes Link to the release timeline document
feature_completion_status list Yes Status of completed features from development tracking
integration_test_results report Yes Passing E2E test results confirming platform stability
wg_release_notes list of documents Yes Per-component release notes from each Working Group

Outputs

Name Type Description
updated_roadmap file (ROADMAP.md) Updated ROADMAP.md with new release section prepended at the top
updated_docs_site URL Updated kubeflow.org documentation reflecting new release features and guides
component_release_notes list of URLs Links to published release notes in each sub-project repository
upgrade_guide document Instructions for users upgrading from the previous release

Usage Examples

Example: ROADMAP.md Release Section Structure

# Structure of a release section in ROADMAP.md:
# Line 1: # Kubeflow AI Reference Platform Roadmap
# Line 2: ## Kubeflow 1.11 Release, Planned for release: December 2025
# Line 3: The Kubeflow Community plans to deliver its v1.11 release
#          in December 2025 per this timeline...
# Line 4: ### Themes
# Line 5: * Trainer V2.0
# Line 6: * Model Registry new features
# Line 7: * KServe improvements
# ...
# Line N: ### Detailed features, bug fixes and enhancements
# Line N+1: * [Trainer](https://github.com/kubeflow/trainer/issues/2859)
# Line N+2: * [KServe](https://github.com/kserve/kserve/releases/tag/v0.15.2)
# Line N+3: * [Katib](https://github.com/kubeflow/katib/releases/tag/v0.19.0)
# Line N+4: * [Pipelines](https://github.com/kubeflow/pipelines/releases/tag/2.15.0)
# Line N+5: * [Model Registry](https://github.com/kubeflow/model-registry/releases/tag/v0.3.4)
# Line N+6: * [Spark Operator](https://github.com/kubeflow/spark-operator/releases/tag/v2.4.0)

Example: Adding a New Release Section to ROADMAP.md

# Create a branch for the ROADMAP update
git checkout -b roadmap-v1.11
cd kubeflow

# The new section is prepended after the main heading (newest-first ordering)
# Edit ROADMAP.md to add the v1.11 section between the title and the v1.10 section

git add ROADMAP.md
git commit -m "Add Kubeflow v1.11 release section to ROADMAP.md"

# Create a PR for review
gh pr create \
  --title "Add v1.11 release section to ROADMAP.md" \
  --body "Adds the v1.11 release section with themes and per-WG tracking links."

Example: Updating kubeflow.org Documentation

# Clone the website repository
git clone https://github.com/kubeflow/website.git
cd website

# Create a branch for documentation updates
git checkout -b docs-v1.11

# Update version references in documentation
# Update installation guides for new component versions
# Add new feature documentation pages
# Update API reference pages

# Build and preview locally
make serve

# Submit documentation PR
git add -A
git commit -m "Update documentation for Kubeflow v1.11 release"
gh pr create \
  --title "Documentation updates for Kubeflow v1.11" \
  --body "Updates installation guides, feature docs, and API references for v1.11."

Example: Compiling Component Release Notes

# Fetch release notes from each sub-project
gh release view v0.15.2 --repo kserve/kserve --json body -q .body
gh release view v0.19.0 --repo kubeflow/katib --json body -q .body
gh release view 2.15.0 --repo kubeflow/pipelines --json body -q .body
gh release view v0.3.4 --repo kubeflow/model-registry --json body -q .body
gh release view v2.4.0 --repo kubeflow/spark-operator --json body -q .body

# Compile into a unified release notes summary
# for publication on the Kubeflow website release page

Related Pages

Implements Principle

Page Connections

Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment