rkt/rkt

manpages: too simple description of `--insecure-options`

Open

#2,381 建立於 2016年4月5日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Go (8,871 star) (865 fork)batch import
area/usabilityhelp wantedlow hanging fruit

描述

Each generated manpage has below description:

--insecure-options=none
    comma-separated list of security features to disable. Allowed values: "none", "image", "tls", "ondisk", "http", "pubkey", "all"

IMO this is unusable description about allowed values for this option.

貢獻者指南

技術棧
go
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
95
研究方向
The issue requests a more detailed description of the ` insecure options` flag in the manpages. Look for the manpage generation code in the rkt repository, likely in a file that templates the manpage output, and update the description to explain each allowed value (none, image, tls, ondisk, http, pubkey, all). The change is localized and does not require deep understanding of the codebase.