Populating api-types & concepts #254
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kfswain 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 |
k8s-ci-robot
added
approved
✅ Deploy Preview for gateway-api-inference-extension ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
site-src/concepts/api-overview.md
Outdated
| ## Background | ||
| The API design is based on these axioms: |
There was a problem hiding this comment.
My suggestion is to focus more on the relationship between the two apis and links to the apis docs we have above and less about how we ended up here (i.e., the design) since this is more of a user-facing documentation?
There was a problem hiding this comment.
Fair points, took a stab here. PTAL
k8s-ci-robot
added
size/L
site-src/concepts/api-overview.md
Outdated
| @@ -3,8 +3,7 @@ | |||
| ## Bakcground | |||
| The Gateway API Inference Extension project is an extension of the Kubernetes Gateway API for serving Generative AI models on Kubernetes. Gateway API Inference Extension facilitates standardization of APIs for Kubernetes cluster operators and developers running generative AI inference, while allowing flexibility for underlying gateway implementations (such as Envoy Proxy) to iterate on mechanisms for optimized serving of models. | |||
|
|
|||
| <img src="/images/inference-overview.png" alt="Overview of API integration" class="center" width="700" /> | |||
|
|
|||
| <img src="/images/test.svg" alt="Overview of API integration" class="center" width="1000" /> | |||
There was a problem hiding this comment.
can we rename the image to inference-overview.svg?
|
/lgtm |
k8s-ci-robot
added
the
lgtm
Meant to be one PR of many in clearing out the TODOs in our documentation.
Breaking them up so reviews are more tightly scoped and folks arent getting bodied with a huge PR.
Most of this is just migration of our pre-exisiting proposal for now.