istio/istio.io

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

Open

#12,698 opened on 2023年2月17日

GitHub で見る
 (7 comments) (0 reactions) (1 assignee)HTML (740 stars) (1,492 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.