kubernetes/minikube

Make website have versions matching releases

Open

#12,391 opened on Sep 2, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Go (31,799 stars) (5,222 forks)batch import
help wantedkind/documentationlifecycle/frozenpriority/backlog

Description

I just addressed a PR (#12387) where a user was proposing to remove a flag from the documentation because when they ran --help on the latest version of minikube that flag wasn't present. This was because the PR (#11553) that added the flag was merged after last release, so the documentation was updated but the feature doesn't yet exist in the latest version of minikube.

Thought this was worth discussing since this can be confusing to users if they read a flag or new command in the documentation but it's not actually available in the latest version of minikube. Maybe we cam have a way to only update documentation on the website after a release.

Contributor guide

Tech stack
go
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the minikube website build process, likely in the docs/ or site/ directory, and propose a versioning system that aligns documentation with releases. Review PR #12387 and #11553 for context on the problem and potential solutions.