istio/istio.io

Rate limiting documentation does not warn it is experimental

Open

#10,120 opened on Jul 26, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)HTML (740 stars) (1,492 forks)batch import
area/extensions and telemetryhelp wanted

Description

https://preliminary.istio.io/latest/docs/tasks/policy-enforcement/rate-limit/

This is relying on unstable EnvoyFilter API that is going to be replaced, with no warning. We should add the standard warning we have on other docs

cc @mandarjog @kyessenov

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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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
Basic knowledge of Istio documentationFamiliarity with markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Look at other experimental warnings in the Istio documentation (e.g., search for 'experimental' in the repo). Add a similar warning banner to the rate limiting page at https://preliminary.istio.io/latest/docs/tasks/policy enforcement/rate limit/. The warning should indicate that this feature relies on the unstable EnvoyFilter API which is going to be replaced. Copy the standard warning format used elsewhere.
Rate limiting documentation does not warn it is experimental · istio/istio.io#10120 | Good First Issue