search

kubernetes-sigs / gateway-api

Repository for the next iteration of composite service (e.g. Ingress) and load balancing APIs.
https://gateway-api.sigs.k8s.io
Apache License 2.0
1.86k stars 482 forks source link

Add Documentation for BackendLBPolicy (v1.1 Experimental) #3461

Open amitmaurya07 opened 5 days ago

amitmaurya07 commented 5 days ago

Pull Request: Add Documentation for BackendLBPolicy

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR introduces a user-facing documentation page for BackendLBPolicy, which was released as experimental in v1.1. The documentation provides details on the goals of the policy, how to use it, and descriptions of its fields. This documentation is aimed at making it easier for end users to understand and apply the BackendLBPolicy without needing to refer to the GEP.

Which issue(s) this PR fixes:

Fixes #3201 (If applicable)

Does this PR introduce a user-facing change?

Yes, this introduces a new documentation page that describes the BackendLBPolicy and its usage.


Added a new documentation page for BackendLBPolicy, explaining its goals, usage, and field descriptions.
k8s-ci-robot commented 5 days ago

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
linux-foundation-easycla[bot] commented 5 days ago

CLA Signed

The committers listed above are authorized under a signed CLA.

k8s-ci-robot commented 5 days ago

Welcome @amitmaurya07!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. :smiley:

k8s-ci-robot commented 5 days ago

Hi @amitmaurya07. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
mikemorris commented 5 days ago

/ok-to-test

amitmaurya07 commented 5 days ago

Hello @youngnick Thank you for the feedback! I had applied the suggested syntax changes for better clarity. Please let me know if there are any specific areas you'd like me to focus on.

youngnick commented 1 day ago

Nice work, I'll approve and leave this for someone else to LGTM.

/approve

k8s-ci-robot commented 1 day ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: amitmaurya07, youngnick

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[site-src/OWNERS](https://github.com/kubernetes-sigs/gateway-api/blob/main/site-src/OWNERS)~~ [youngnick] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment