docs(ingress): add note about OpenShift Gateway API and link to OpenShift guide
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 92/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Stack tecnológico
- kubernetes, markdown
- Área
- documentation
Línea de trabajo
Comienza con docs/kubernetes/ingress.mdx y compara la guía existente de OpenShift en docs/kubernetes/openshift/gateway-connection.mdx. Añade la Note especificada después del párrafo introductorio y antes de "## Install Envoy Gateway". Se considera terminado cuando los usuarios de OpenShift son dirigidos a la guía de OpenShift sin duplicar su contenido.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Rust
- Estrellas
- 8.7k
- Forks
- 1.3k
- Merge medio
- 2 d 6 h
- PR fusionados (30 d)
- 236
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de NVIDIA/OpenShell
-
area:docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
-
state:triage-needed
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
area:cli state:validated
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
state:triage-needed
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
-
area:build spike state:review-ready state:stale
Dificultad 2/5 Medio día Aptitud para principiantes 68/100
Todos los issues de NVIDIA/OpenShell
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
gitbutlerapp/gitbutler#15998 · 1 comentario ·
-
bug triage:deciding
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
open-telemetry/otel-arrow#4132 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100