kubernetes-sigs / kubernetes-sigs/gateway-api

Add documentation for BackendLBPolicy

Open
#3,201 9 comments 0 reactions 1 assignee View on GitHub

@amitmaurya07 is already working on this.

Since Oct 7, 2024.

help wanted kind/documentation priority/important-longterm triage/accepted
Dominant language
Go
Stars
3k
Forks
790
Avg merge
2d 15h
Merged PRs (30d)
45

Description

What would you like to be added:

Similar to https://gateway-api.sigs.k8s.io/api-types/backendtlspolicy/, we should have a dedicated documentation page for BackendLBPolicy, which was released as experimental in v1.1.

The documentation should describe the goals of BackendLBPolicy, how to use the policy, and descriptions of the fields.

Why this is needed:

Though the current usage of BackendLBPolicy is documented well in GEP-1619, we should have a user-facing doc to be consistent with BackendTLSPolicy, as we don't expect end-users to dig through GEPs to better understand how a policy works.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.