kubernetes/minikube

Make website documentation versioned

Open

#6,921 opened on Mar 6, 2020

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

Repository metrics

Stars
 (31,799 stars)
PR merge metrics
 (Avg merge 12d 19h) (43 merged PRs in 30d)

Description

we recently updated docs that --vm-driver to --driver and that was true for head ! but not for the binary that people donwload and use.

so we need versioned documentation for HEAD and also for releases.

Contributor guide

Research direction
Research how to implement versioned documentation, possibly using a static site generator like Docusaurus or Hugo with versioning plugins, to maintain separate docs for HEAD and each release.
Tech stack
go
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.
Half day
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60