Skip to content

docs: add --params flag and schema-driven param docs across all references#193

Merged
mrhillsman merged 1 commit into
mainfrom
docs/update-params-documentation
Jun 13, 2026
Merged

docs: add --params flag and schema-driven param docs across all references#193
mrhillsman merged 1 commit into
mainfrom
docs/update-params-documentation

Conversation

@mrhillsman

Copy link
Copy Markdown
Contributor

Summary

  • Document the new --params CLI flag and VIRTWORK_PARAMS env var in README.md and configuration.md flag/env tables.
  • Update the priority chain description in configuration.md to reflect that per-workload params are no longer YAML-only.
  • Update architecture.md file tree to include params.go and the RegistryEntry+ValidateParams descriptions.
  • Update chaos-workloads.md contributor section for the schema-driven GetParam pattern.
  • Add --params CLI example in the deploying-workloads guide alongside the existing YAML example.

…ences

Document the new --params CLI flag and VIRTWORK_PARAMS env var in
README.md and configuration.md flag/env tables. Update the priority
chain description in configuration.md to reflect that per-workload
params are no longer YAML-only. Update architecture.md file tree to
include params.go and the RegistryEntry+ValidateParams descriptions.
Update chaos-workloads.md contributor section for the schema-driven
GetParam pattern. Add --params CLI example in the deploying-workloads
guide alongside the existing YAML example.

Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
@exe-prow-github-app exe-prow-github-app Bot requested a review from OchiengEd June 13, 2026 01:37
@exe-prow-github-app

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mrhillsman

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@exe-prow-github-app exe-prow-github-app Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 13, 2026
@mrhillsman mrhillsman removed the request for review from OchiengEd June 13, 2026 01:37
@mrhillsman mrhillsman merged commit f9192c9 into main Jun 13, 2026
3 of 4 checks passed
@mrhillsman mrhillsman deleted the docs/update-params-documentation branch June 15, 2026 03:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. related-to/docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant