docs(examples): add ray-serve and dynamo-operator to sample index#37
Open
mmjinglin163 wants to merge 1 commit into
Open
docs(examples): add ray-serve and dynamo-operator to sample index#37mmjinglin163 wants to merge 1 commit into
mmjinglin163 wants to merge 1 commit into
Conversation
Both helm chart samples exist under examples/function-samples/helmchart-samples/ but were missing from the top-level examples index table. Signed-off-by: mmjinglin <mmjinglin@163.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
|
Hi @mmjinglin163 thank you for the contribution, the change looks good and is approved - We currently accept contributions through coauthoring, we will accept this contribution tomorrow |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
Add two existing helm chart function samples to the top-level
examples/README.mdindex: Ray Serve and Dynamo Operator. Both directories already live underexamples/function-samples/helmchart-samples/with README and chart assets, but were not listed in the Function Samples table, so contributors could miss them when browsing the repo.Additional Details
The
examples/README.mdfile is the entry point for self-hosted sample discovery. Several helm chart samples are indexed there (for exampleinference-test-sampleandmulti-node-helm-function-test), butray-serve-sampleanddynamo-operator-samplewere omitted despite being present in the tree.This change adds one table row per sample with a relative link and a short description consistent with existing index entries:
ray-serve-sample: Ray Serve deployed as an NVCF Helm functiondynamo-operator-sample: vLLM disaggregated router deployed through NVCFNo sample code, charts, or runtime behavior is modified. No Fern navigation or
docs/user/pages are affected.Limitations: This PR does not expand the thin
vllm-otlp-exporter-sampleREADME or add new samples. Those are separate follow-up contributions.For the Reviewer
Please review only
examples/README.md. The diff is two inserted table rows placed after the Multi-Node Helm Function entry and before Load Tester Supreme.Verify that:
No maintainer action is required beyond a quick path and wording check.
For QA
Verification steps run locally:
Results:
git diff --check: passed (no trailing whitespace)Is QA Needed? No runtime QA. Docs-only index update; no cluster deploy or Bazel build required.
Issues
Checklist