Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for Ingress resource object is stale, documents deprecated APIs #5450

Open
darkn3rd opened this issue Nov 21, 2023 · 1 comment
Open
Labels
a:docs Issue relates to documentation

Comments

@darkn3rd
Copy link

Describe the bug

The current documentation for the Ingress resource object only documents the networking.k8s.io/v1beta1 API from Kubernetes 1.18 in 2020. It has not been updated since then, and links reference a blog on Medium that is equally stale. The source code seems to support the current API. Also, other deprecated APIs that are not supported with emissary-ingress are documented.

To Reproduce

Steps to reproduce the behavior:

  1. Navigate to Ingress documentation and find this https://www.getambassador.io/docs/emissary/latest/topics/running/ingress-controller#when-and-how-to-use-the-ingress-resource
  2. As a part of the instructions, an external blog is referenced, which also covers deprecated API: https://blog.getambassador.io/new-kubernetes-1-18-extends-ingress-c34abdc2f064

Expected behavior

I expected that the documentation would document the current supported API in regards to Ingress, i.e. networking.k8s.io/v1. I also expected that the documentation would be complete with examples, and not defer to external blogs with more deprecated APIs.

Versions (please complete the following information):

  • Ambassador: 3.9.1
  • Kubernetes environment: GKE (v1.27.3-gke.100)

Additional context

Docs need love too.

@cindymullins-dw cindymullins-dw added the a:docs Issue relates to documentation label Dec 1, 2023
@darkn3rd
Copy link
Author

darkn3rd commented Apr 6, 2024

I hope someone can look at this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:docs Issue relates to documentation
Projects
None yet
Development

No branches or pull requests

2 participants