Skip to content

chore(docs): update docs#328

Merged
dmitsh merged 1 commit into
mainfrom
ds-docs1
May 14, 2026
Merged

chore(docs): update docs#328
dmitsh merged 1 commit into
mainfrom
ds-docs1

Conversation

@dmitsh
Copy link
Copy Markdown
Collaborator

@dmitsh dmitsh commented May 14, 2026

Description

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.
  • All commits are signed off per DCO (git commit -s).

Signed-off-by: Dmitry Shmulevich <dshmulevich@nvidia.com>
@dmitsh dmitsh merged commit 03e70a5 into main May 14, 2026
4 checks passed
@dmitsh dmitsh deleted the ds-docs1 branch May 14, 2026 23:21
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 14, 2026

Greptile Summary

This PR updates three documentation files: it narrows the example Helm schema validation error in k8s.md, adds nscale to the quickstart provider list, and updates the node-labels reference to reflect that gcp (SubblockId) and oci (GpuMemoryFabricId) now produce block topology labels.

  • docs/engines/k8s.md: The example schema-validation error was updated to list only 10 providers, but charts/topograph/values.schema.json still enumerates 19 — the docs and the live schema are now out of sync.
  • docs/get-started/quickstart-k8s.md: Adds nscale to the supported provider list; dra is retained, consistent with the actual Helm schema.
  • docs/reference/node-labels.md: Corrects the provider capability matrix to reflect that gcp and oci now populate the accelerator (block) label.

Confidence Score: 3/5

The two smaller file changes are accurate, but k8s.md now documents a schema error list that diverges from the actual values.schema.json, which will confuse operators who encounter the real error.

The example error output in k8s.md was trimmed to 10 providers while the Helm schema still validates against 19. Any user who triggers that validation error will see a different list than the docs show, making the documentation actively misleading. The other two files look correct.

docs/engines/k8s.md needs its example error output reconciled with charts/topograph/values.schema.json

Important Files Changed

Filename Overview
docs/engines/k8s.md Example Helm schema error output now lists only 10 providers, but values.schema.json contains 19 — the docs will mislead users who see the real, longer error.
docs/get-started/quickstart-k8s.md Adds nscale to the supported-provider list; dra is retained and remains valid per the actual schema.
docs/reference/node-labels.md Marks gcp as supporting block topology (SubblockId) and oci as supporting block topology (GpuMemoryFabricId) — straightforward accuracy updates.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[helm install --set global.provider.name=X] --> B{Helm schema validation\nvalues.schema.json}
    B -- "X in 19-item enum" --> C[Template renders successfully]
    B -- "X not in enum" --> D[Error: value must be one of...\n19 providers listed]
    D -.->|"Docs (k8s.md) show\nonly 10 providers"| E[User confusion:\ndocs don't match real error]
    C --> F[Provider topology discovery\naws / oci / gcp / nscale / etc.]
    F --> G[Node labels written\naccelerator / leaf / spine / core]
Loading

Reviews (1): Last reviewed commit: "chore(docs): update docs" | Re-trigger Greptile

Comment thread docs/engines/k8s.md
Error: values don't meet the specifications of the schema(s) in the following chart(s):
topograph:
- at '/global/provider/name': value must be one of 'aws', 'aws-sim', 'cw', 'dra', 'dsx-sim', 'gcp', 'gcp-sim', 'infiniband-bm', 'infiniband-k8s', 'lambdai', 'lambdai-sim', 'nebius', 'nscale', 'netq', 'oci', 'oci-imds', 'oci-sim', 'test'
- at '/global/provider/name': value must be one of 'aws', 'oci', 'gcp', 'cw', 'infiniband-k8s', 'lambdai', 'nebius', 'nscale', 'netq', 'test'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Example error message no longer matches the real schema

The updated example only lists 10 providers (aws, oci, gcp, cw, infiniband-k8s, lambdai, nebius, nscale, netq, test), but charts/topograph/values.schema.json still enumerates 19 values: aws, aws-sim, cw, dra, gcp, gcp-sim, dsx-sim, infiniband-bm, infiniband-k8s, lambdai, lambdai-sim, nebius, netq, nscale, nscale-sim, oci, oci-imds, oci-sim, test. A user who supplies --set global.provider.name=bogus will see Helm emit the full 19-item list, not this abbreviated one, making the docs misleading. Either update values.schema.json to match the narrower list, or restore the full enum in the example.

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.

1 participant