kubernetes/minikube

Make website documentation versioned

Open

#6,921 建立於 2020年3月6日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)Go (31,799 star) (5,222 fork)batch import
help wantedkind/documentationlifecycle/frozenpriority/backlog

描述

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.

貢獻者指南

技術棧
go
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
understanding of documentation versioning
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Investigate the current documentation system in the minikube repository (e.g., look for a docs/ directory, configuration files like config.toml, or references to static site generators). Determine how documentation is built and deployed, especially how versions are handled. Explore if there is an existing versioning mechanism (e.g., using a version parameter in Hugo) or if a new system needs to be implemented. Check the repository's Makefile and CI/CD scripts for documentation deployment steps. Examine linked issues or comments for any prior work or discussions.