Skip to content

docs: add concepts and defs to README.md #680

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

Closed

Conversation

shaneutt
Copy link
Member

This adds some potential helpful concepts and definitions for newcomers to the repository and the community.

@k8s-ci-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 11, 2025
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 11, 2025
Copy link

netlify bot commented Apr 11, 2025

Deploy Preview for gateway-api-inference-extension ready!

Name Link
🔨 Latest commit b637b1b
🔍 Latest deploy log https://app.netlify.com/sites/gateway-api-inference-extension/deploys/67ff92e6bf3522000830f219
😎 Deploy Preview https://deploy-preview-680--gateway-api-inference-extension.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@shaneutt shaneutt force-pushed the shaneutt/readme-concepts-defs branch from 6d24bda to cb449a5 Compare April 11, 2025 15:34
@k8s-ci-robot k8s-ci-robot requested a review from kfswain April 11, 2025 17:27
@shaneutt shaneutt force-pushed the shaneutt/readme-concepts-defs branch from 28cd946 to 80cdfe1 Compare April 11, 2025 20:29
@shaneutt shaneutt requested a review from ahg-g April 11, 2025 20:30
@shaneutt shaneutt force-pushed the shaneutt/readme-concepts-defs branch 2 times, most recently from 18afde6 to 2a59553 Compare April 14, 2025 12:18
@shaneutt shaneutt force-pushed the shaneutt/readme-concepts-defs branch from 2a59553 to d305093 Compare April 14, 2025 13:42
@shaneutt shaneutt requested a review from ahg-g April 14, 2025 13:44
@shaneutt shaneutt marked this pull request as ready for review April 14, 2025 13:44
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 14, 2025
@k8s-ci-robot k8s-ci-robot requested a review from danehans April 14, 2025 13:44
@shaneutt shaneutt force-pushed the shaneutt/readme-concepts-defs branch from d305093 to 5fbb16d Compare April 14, 2025 14:48
@shaneutt shaneutt requested a review from ahg-g April 14, 2025 14:48
@ahg-g
Copy link
Contributor

ahg-g commented Apr 14, 2025

Thanks @shaneutt, looks good to me, I will leave the final tag to @kfswain

@kfswain
Copy link
Collaborator

kfswain commented Apr 14, 2025

Yeah! I think this looks great also, I'll apply all approval labels + a hold to give a chance to take a look at the nit/submit on your own terms. But if you're ready to merge just pull the hold off. Thanks for taking the time and care to enrich our landing page! Laying some ground definitions makes a lot of sense.

/lgtm
/approve
/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 14, 2025
@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Apr 14, 2025
@nirrozenbaum
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 14, 2025
@shaneutt shaneutt force-pushed the shaneutt/readme-concepts-defs branch from 77a2a20 to 9925a1c Compare April 14, 2025 17:11
@shaneutt shaneutt requested a review from kfswain April 14, 2025 17:11
@shaneutt shaneutt force-pushed the shaneutt/readme-concepts-defs branch from 36740ef to 761c992 Compare April 15, 2025 16:53
@shaneutt shaneutt requested a review from danehans April 15, 2025 16:53
@shaneutt shaneutt force-pushed the shaneutt/readme-concepts-defs branch from 2030338 to 839d74c Compare April 15, 2025 19:27
@shaneutt shaneutt force-pushed the shaneutt/readme-concepts-defs branch from 839d74c to b18bd63 Compare April 15, 2025 19:28
@shaneutt shaneutt requested a review from danehans April 15, 2025 19:29
@kfswain
Copy link
Collaborator

kfswain commented Apr 16, 2025

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 16, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kfswain, shaneutt

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:

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

@kfswain
Copy link
Collaborator

kfswain commented Apr 16, 2025

I would unhold and ship it, but will leave it as I don't want to stomp on any discussion being had.

Thanks @shaneutt!!

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 16, 2025
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 16, 2025
@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 16, 2025
@shaneutt shaneutt requested a review from Kellthuzad April 16, 2025 11:22
@danehans
Copy link
Contributor

@shaneutt consider leveraging this doc which provides good definitions for several applicable terms.

@shaneutt
Copy link
Member Author

@shaneutt consider leveraging this doc which provides good definitions for several applicable terms.

Could you help me please to better understand how precisely you're hoping for this to be incorporated? In particular, suggestion comments with explicit suggestions about changes would be ideal because they don't leave any room for misinterpretation.

@danehans
Copy link
Contributor

@shaneutt IMHO, we should consider leveraging each term and associated definition from https://cloud.google.com/kubernetes-engine/docs/concepts/machine-learning/inference#terminology.

@shaneutt
Copy link
Member Author

Github seems to be unable to track my branch at the moment, after my fork moved, so I'm going to re-create.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants