Skip to content

docs: document --use-docker and --no-docker options in cfn submit#1120

Open
cv-dote wants to merge 1 commit intoaws-cloudformation:masterfrom
cv-dote:docs/submit-docker-options
Open

docs: document --use-docker and --no-docker options in cfn submit#1120
cv-dote wants to merge 1 commit intoaws-cloudformation:masterfrom
cv-dote:docs/submit-docker-options

Conversation

@cv-dote
Copy link
Copy Markdown

@cv-dote cv-dote commented May 1, 2026

Issue #, if available: #1119

Description of changes:

Summary

Document the --use-docker and --no-docker options of cfn submit in doc_source/resource-type-cli-submit.md.

These options were added to the CLI in #970 but were never reflected in the documentation. As a result, the public AWS documentation page (generated from doc_source/) does not mention them either.

Changes

  • Add [--use-docker] and [--no-docker] to the Synopsis block.
  • Add an Options entry for each flag, describing:
    • What the flag does.
    • That --use-docker and --no-docker are mutually exclusive.
    • That these flags override the corresponding setting in the project's .rpdk-config.

No code changes. The wording for the options is adapted from the existing help= strings in src/rpdk/core/submit.py so that cfn submit --help and the documentation stay consistent.

Verification

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

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