Kong / Kong/docs.konghq.com

KIC: Introduce annotations available for gateway API resources

Open
#6,606 1 comment 1 reaction 0 assignees View on GitHub
team-k8s
Dominant language
Ruby
Stars
212
Forks
587
PR merge metrics
No merged PRs in 30d

Description

### Where is the problem?

https://docs.konghq.com/kubernetes-ingress-controller/latest/reference/annotations/

### What happened?

There is no introduction on annotations could be used on gateway API resources, such as `HTTPRoute` in the annotations page. Basically, `HTTPRoute` supports the same annotations as `Ingress`, but since some features like method match and header match are available in specs of `HTTPRoute`, so we disabled the annotations (when expression router enabled). We need to add introductions about the differences.

### What did you expect to happen?

There is a section to introduce annotations could be applied on gateway API resources like `HTTPRoute`.

### Code of Conduct and Community Expectations

- [X] I agree to follow this project's Code of Conduct
- [X] I agree to abide by the Community Expectations

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the annotations reference page at https://docs.konghq.com/kubernetes-ingress-controller/latest/reference/annotations/. Add a section covering annotations available on Gateway API resources such as HTTPRoute, including how they differ from Ingress annotations and which features are disabled when the expression router is enabled. Done means the page explains these differences clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.