Skip to content

docs(examples): add ray-serve and dynamo-operator to sample index#37

Open
mmjinglin163 wants to merge 1 commit into
NVIDIA:mainfrom
mmjinglin163:USER/docs/examples-index
Open

docs(examples): add ray-serve and dynamo-operator to sample index#37
mmjinglin163 wants to merge 1 commit into
NVIDIA:mainfrom
mmjinglin163:USER/docs/examples-index

Conversation

@mmjinglin163

Copy link
Copy Markdown

TL;DR

Add two existing helm chart function samples to the top-level examples/README.md index: Ray Serve and Dynamo Operator. Both directories already live under examples/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.md file is the entry point for self-hosted sample discovery. Several helm chart samples are indexed there (for example inference-test-sample and multi-node-helm-function-test), but ray-serve-sample and dynamo-operator-sample were 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 function
  • dynamo-operator-sample: vLLM disaggregated router deployed through NVCF

No 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-sample README 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:

  • Link paths match existing directories
  • Descriptions match the intent of each sample's local README

No maintainer action is required beyond a quick path and wording check.

For QA

Verification steps run locally:

git diff --check
git diff examples/README.md
test -f examples/function-samples/helmchart-samples/ray-serve-sample/README.md
test -f examples/function-samples/helmchart-samples/dynamo-operator-sample/README.md

Results:

  • git diff --check: passed (no trailing whitespace)
  • Linked README paths: both exist
  • Diff scope: 1 file, 2 lines added

Is QA Needed? No runtime QA. Docs-only index update; no cluster deploy or Bazel build required.

Issues

  • NO-REF

Checklist

  • I am familiar with the Contributing Guidelines.
  • I have signed off my commits for Developer Certificate of Origin (DCO) compliance.
  • New or existing tests cover these changes. (N/A: documentation index only; no executable code changed.)
  • The documentation is up to date with these changes.

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>
@mmjinglin163 mmjinglin163 requested a review from a team as a code owner June 25, 2026 06:21
@sbaum1994

Copy link
Copy Markdown
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants