istio/istio.io

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

Open

#12,698 opened on Feb 17, 2023

View on GitHub
 (7 comments) (0 reactions) (1 assignee)HTML (740 stars) (1,492 forks)batch import
community/testing daysgood first issuelifecycle/staleproof

Description

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?

Contributor guide

Tech stack
html
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Istio feature lifecycleBasic markdown editing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.