-
Notifications
You must be signed in to change notification settings - Fork 29
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
Adding some initial docs content and diagrams #129
Conversation
/lgtm |
[vLLM](https://github.com/vllm-project/vllm) and | ||
[Triton](https://github.com/triton-inference-server/server), and will be open to | ||
other integrations as they are requested. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Part of #72 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few nits, otherwise /LGTM.
processor: | ||
ignoreTypes: | ||
- "(InferencePool|InferenceModel)List$" | ||
# RE2 regular expressions describing type fields that should be excluded from the generated documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RE2
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a specific flavor of regex: https://github.com/google/re2/wiki/syntax - this is copied from the sample config file for crd-ref-docs
|
||
The overall resource model focuses on 2 new inference-focused | ||
[personas](/concepts/roles-and-personas) and corresponding resources that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that roles-and-personas.md
is in a TODO state.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I'm just trying to get something WIP in and then hopefully it's easier to split up the remaining docs into smaller PRs by more people.
4b4eb91
to
b0567a8
Compare
b0567a8
to
e575cc3
Compare
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: danehans, kfswain, robscott 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 |
* Adding some initial docs content and diagrams * Adding FAQ, contributing, and implementations pages * Adding generated API docs + basic API docs and diagram * Cleanup from PR feedback
Initial WIP attempt of some content for our docs.