istio/istio.io

Rate limiting documentation does not warn it is experimental

Open

#10,120 opened on 2021年7月26日

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

説明

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

コントリビューターガイド

技術スタック
html
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Basic knowledge of Istio documentationFamiliarity with markdown
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90
調査方針
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