docs(ingress): add note about OpenShift Gateway API and link to OpenShift guide
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 92/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- kubernetes, markdown
調査の方向性
docs/kubernetes/ingress.mdx から始め、docs/kubernetes/openshift/gateway-connection.mdx にある既存の OpenShift 向けガイダンスと比較します。導入段落の後、"## Install Envoy Gateway" の前に、指定された Note を追加します。OpenShift ユーザーがその内容を重複させることなく OpenShift ガイドに誘導されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Problem Statement
The ingress docs (docs/kubernetes/ingress.mdx) only cover Envoy Gateway. On OpenShift, Envoy Gateway cannot be installed because the Ingress Operator manages Gateway API CRDs and rejects third-party installations. Users following the ingress guide on OpenShift hit an error with no guidance on what to do instead.
Proposed Design
Add a <Note> callout at the top of docs/kubernetes/ingress.mdx directing OpenShift users to the OpenShift-specific guide:
<Note>
On OpenShift, the Ingress Operator manages Gateway API CRDs and Envoy Gateway cannot be installed.
Refer to [OpenShift — Gateway Connection](/kubernetes/openshift/gateway-connection) for OpenShift-specific
ingress options including reencrypt Routes and the Istio-based Gateway API controller.
</Note>
Changes required
docs/kubernetes/ingress.mdx— add the<Note>after the introductory paragraph (before "## Install Envoy Gateway")
Alternatives Considered
-
Add a full OpenShift section to
ingress.mdx: Would duplicate content already covered indocs/kubernetes/openshift/gateway-connection.mdx. A cross-reference note is sufficient. -
Do nothing, rely on the OpenShift section: Users coming from the Kubernetes nav sidebar would land on
ingress.mdxfirst and not know to check the OpenShift section.
- I've reviewed existing issues and the architecture docs
- This is a design proposal, not a "please build this" request
- 主要言語
- Rust
- スター
- 8.7k
- フォーク
- 1.3k
- 平均マージ
- 2日 6時間
- マージ済み PR（30日）
- 236
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NVIDIA/OpenShell のほかの issue
-
area:docs
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
-
state:triage-needed
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
area:cli state:validated
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
state:triage-needed
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
area:build spike state:review-ready state:stale
難易度 2/5 半日 初心者へのやさしさ 68/100
NVIDIA/OpenShell の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug team:backend track:services-maintenance
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
cowprotocol/services#4950 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
gitbutlerapp/gitbutler#15998 · コメント 1 件 ·
-
bug triage:deciding
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
open-telemetry/otel-arrow#4132 ·