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

Improve kubernetes.io docs with additional Gateway API pointers and information #3268

Open
mlavacca opened this issue Aug 13, 2024 · 2 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Milestone

Comments

@mlavacca
Copy link
Member

What would you like to be added:

The official kubernetes.io docs contain a Gateway API section that can be improved in some ways to better advertise our project over Ingress API.

The following is a non-exhaustive list of parts that can be changed/added to gain more visibility on the main documentation:

  • The Gateway API description can be expanded to make clear this is an alternative to the Ingress API and provides all the Ingress API features + many more.
  • in the Gateway API page, make clear that users need a Gateway API implementation, similar to what Ingress requires, and provide our link to the Gateway API implementations.
  • improve the migrating from ingress section, by directly adding links to ingress2gateway, advertising it as a useful tool to perform the migration. Be sure to list the tool's limitations, like the fact that not all the implementations are supported yet.
  • improve the Gateway API page with a section on gwctl, explaining as it can be useful to inspect and manage user's Gateway API configuration.
@mlavacca mlavacca added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 13, 2024
@Nishant-k-sagar
Copy link

Hey @mlavacca I would like to work on this issue, I can update the information as per given details by simply adding required lines of code.

@shaneutt shaneutt added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on. labels Aug 16, 2024
@shaneutt shaneutt added this to the v1.3.0 milestone Aug 16, 2024
@shaneutt shaneutt added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Aug 16, 2024
@mlavacca
Copy link
Member Author

Hi @Nishant-k-sagar, we really appreciate your interest on this issue, but this is unfortunately not very suitable for a new contributor, as it needs a thorough knowledge of Gateway API and K8S docs. I invite you to look for something else marked as a good starting point for new contributors: good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. . For example, Rob has recently created a new CI-related issue that can be a great point to start gaining confidence with the project, if you want to take a look: #3282

@shaneutt shaneutt added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Development

No branches or pull requests

3 participants