Skip to content

docs: use envsubst for quick-start examples#375

Open
omribz156 wants to merge 1 commit into
Mellanox:mainfrom
omribz156:codex/envsubst-quickstart-examples
Open

docs: use envsubst for quick-start examples#375
omribz156 wants to merge 1 commit into
Mellanox:mainfrom
omribz156:codex/envsubst-quickstart-examples

Conversation

@omribz156

@omribz156 omribz156 commented May 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Switches quick-start example processing from a generated per-variable sed script to envsubst.
  • Converts the YAML example templates from reStructuredText substitution tokens to shell-style variables, e.g. $NVIDIA_IPAM_REPOSITORY.
  • Keeps the generated examples/processed output stable for the current docs/common/vars.rst values.

Addresses #238.

Verification

  • PowerShell parity check that parses docs/common/vars.rst, renders all examples/templates/**/*.yaml shell variables, and compares the result to the checked-in examples/processed/**/*.yaml files: passed.
  • git diff --check: passed; Git reported only local Windows LF-to-CRLF working-copy warnings.

I could not run make process-examples in this local Windows environment because make, bash, and envsubst are not available here.

This was implemented with Codex assistance, with the patch kept focused and manually reviewed before submission.

Signed-off-by: Omri SirComp <omribz156@gmail.com>
@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown

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