Docs/gamma glossary #3830

Hackmey · 2025-06-04T17:22:00Z

What type of PR is this?
/kind documentation

What this PR does / why we need it:
Moves the Glossary to the GAMMA section to avoid misunderstanding and facilitate clear understanding.

Which issue(s) this PR fixes:
#3803

updated the service-mesh link form glossary to GAMMA glossary

Removed the glossary section and moved it to the GAMMA section. Retitled it as GAMMA glossary. Refactored the links.

k8s-ci-robot · 2025-06-04T17:22:03Z

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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

k8s-ci-robot · 2025-06-04T17:22:08Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Hackmey
Once this PR has been reviewed and has the lgtm label, please assign aojea for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot · 2025-06-04T17:22:09Z

Welcome @Hackmey!

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. 😃

k8s-ci-robot · 2025-06-04T17:22:10Z

Hi @Hackmey. 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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

LiorLieberman

Thanks for picking this up @Hackmey!

Left some comments, though I may not understood the issue well enough.

/cc @candita for clarifications

LiorLieberman · 2025-06-04T20:33:47Z

site-src/index.md

-[north/south traffic]:concepts/glossary.md#northsouth-traffic
-[east/west traffic]:concepts/glossary.md#eastwest-traffic
-[gateway controller]:concepts/glossary.md#gateway-controller
+[north/south traffic]:mesh/gamma-glossary.md#northsouth-traffic


did we mean to move north/south traffic under mesh glossary? @candita

LiorLieberman · 2025-06-04T20:34:00Z

site-src/mesh/gamma.md

-[north/south traffic]:../concepts/glossary.md#northsouth-traffic
-[service mesh]:../concepts/glossary.md#service-mesh
-[east/west traffic]:../concepts/glossary.md#eastwest-traffic
+[north/south traffic]:gamma-glossary.md#northsouth-traffic


same comment here

k8s-ci-robot · 2025-06-04T20:34:47Z

@LiorLieberman: GitHub didn't allow me to request PR reviews from the following users: clarifications, for.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Thanks for picking this up @Hackmey!

Left some comments, though I may not understood the issue well enough.

/cc @candita for clarifications

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

kflynn · 2025-06-05T02:16:33Z

Hey @Hackmey, thanks for looking into reorganizing things!

I'm the one who originally committed the glossary. 🙂 It was definitely not meant to just be a mesh thing – is there a problem you're trying to solve with the move?

craigbox · 2025-06-06T00:03:52Z

geps/gep-1619/index.md

@@ -813,7 +813,7 @@ might not function as expected. In such cases, it's acceptable to make appropria

 The object of the [GAMMA (Gateway API for Mesh Management and Administration)](../../mesh/gamma.md)
 initiative is to provide support for service mesh and mesh-adjacent use-cases with Gateway API. GAMMA is focused on
-defining how Gateway API could also be used for inter-service or [east/west](../../concepts/glossary.md#eastwest-traffic)
+defining how Gateway API could also be used for inter-service or [east/west](../../site-src/mesh/gamma-glossary.md#eastwest-traffic)


site-src will be something that shouldn't leak into URLs

I’ve updated the file based on your suggestion. Let me know if it looks good now! Appreciate the feedback 🙏

Hackmey · 2025-06-07T05:10:42Z

Hi @kflynn, thanks for the clarification!

I’m still pretty new and just following along to learn more. I saw the issue and realized I had a similar reaction, some of the glossary terms felt mesh-related, so I wasn’t sure how they applied to Gateways or xRoutes.

Your explanation helps clear that up! If any changes are needed to make it clearer for new folks, I’d be happy to help with that. Just let me know what would be most useful.

kflynn · 2025-06-09T14:48:06Z

So I think the right thing would be to add more non-mesh terms to the glossary, rather than trying to remove all the non-mesh stuff. Having a glossary that defines the terms of art we use all over the project would be useful. Only having one for mesh terms is... much less useful.

Hackmey · 2025-06-09T16:04:47Z

Totally agree, @kflynn.
A broader glossary would be way more useful. Let me know how I can help, happy to draft definitions!

kflynn · 2025-06-09T21:12:37Z

/hold

(I want to be sure we don't accidentally merge this.)

k8s-ci-robot · 2025-06-20T21:27:06Z

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Hackmey added 4 commits June 4, 2025 21:20

docs: Create gamma-glossary.md

fc90b80

docs: update index.md

58b6095

updated the service-mesh link form glossary to GAMMA glossary

docs: moved GAMMA glossary

0c3b52e

Removed the glossary section and moved it to the GAMMA section. Retitled it as GAMMA glossary. Refactored the links.

Docs: Moved GAMMA Glossary

1d01cfc

k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jun 4, 2025

k8s-ci-robot requested a review from kflynn June 4, 2025 17:22

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 4, 2025

k8s-ci-robot requested a review from robscott June 4, 2025 17:22

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 4, 2025

k8s-ci-robot added the kind/gep PRs related to Gateway Enhancement Proposal(GEP) label Jun 4, 2025

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 4, 2025

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 4, 2025

LiorLieberman reviewed Jun 4, 2025

View reviewed changes

k8s-ci-robot requested a review from candita June 4, 2025 20:34

craigbox reviewed Jun 6, 2025

View reviewed changes

Address review comment: updated link as suggested

d1c842c

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 20, 2025

Docs/gamma glossary #3830

Are you sure you want to change the base?

Docs/gamma glossary #3830

Conversation

Hackmey commented Jun 4, 2025

Uh oh!

k8s-ci-robot commented Jun 4, 2025

Uh oh!

k8s-ci-robot commented Jun 4, 2025

Uh oh!

k8s-ci-robot commented Jun 4, 2025

Uh oh!

k8s-ci-robot commented Jun 4, 2025

Uh oh!

LiorLieberman left a comment

Choose a reason for hiding this comment

Uh oh!

LiorLieberman Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

LiorLieberman Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Jun 4, 2025

Uh oh!

kflynn commented Jun 5, 2025

Uh oh!

craigbox Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

Hackmey Jun 7, 2025

Choose a reason for hiding this comment

Uh oh!

Hackmey commented Jun 7, 2025

Uh oh!

kflynn commented Jun 9, 2025

Uh oh!

Hackmey commented Jun 9, 2025

Uh oh!

kflynn commented Jun 9, 2025

Uh oh!

k8s-ci-robot commented Jun 20, 2025

Uh oh!

Uh oh!