istio/istio.io

Set/update the feature status in the metadata for all features that are not stable

Open

#12,698 建立於 2023年2月17日

在 GitHub 查看
 (7 留言) (0 反應) (1 負責人)HTML (740 star) (1,492 fork)batch import
community/testing daysgood first issuelifecycle/staleproof

描述

Reference to this issue. Right now, the * is used pretty inconsistently through out the docs. There are some features that have the status set but haven't been updated to the current status or in some cases, experimental/alpha/stable features don't have the status set in the markdown.

E.g: JWT Claim based routing on the feature status page says it is Alpha but the status is set to Experimental Authorization Dry Run says it is Alpha but the status is set to Experimental

Question:

  • Do we want to use * to mark all experimental/alpha/beta features or just experimental/alpha or just do not use it at all?

@craigbox @ericvn @howardjohn @kfaseela thoughts?

貢獻者指南

技術棧
html
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Understanding of Istio feature lifecycleBasic markdown editing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Start by reading the referenced issue https://github.com/istio/istio.io/issues/10523 for context. Then identify all feature documentation pages in the repository (likely under content/en/docs/) that have a status metadata field (e.g., status: experimental, alpha, beta, stable). Compare each page's status with the canonical feature status page at https://istio.io/latest/about/feature stages/ and update any inconsistencies. Pay special attention to examples like JWT Claim based routing and Authorization Dry Run. The issue raises a question about whether to use '*' for marking features; check the discussion in comments (especially from @craigbox, @ericvn, @howardjohn, @kfaseela) to decide the approach. After deciding, apply the consistent formatting to all feature pages.