docs: document --use-docker and --no-docker options in cfn submit#1120
Open
cv-dote wants to merge 1 commit intoaws-cloudformation:masterfrom
Open
docs: document --use-docker and --no-docker options in cfn submit#1120cv-dote wants to merge 1 commit intoaws-cloudformation:masterfrom
cv-dote wants to merge 1 commit intoaws-cloudformation:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue #, if available: #1119
Description of changes:
Summary
Document the
--use-dockerand--no-dockeroptions ofcfn submitindoc_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
[--use-docker]and[--no-docker]to the Synopsis block.--use-dockerand--no-dockerare mutually exclusive..rpdk-config.No code changes. The wording for the options is adapted from the existing
help=strings insrc/rpdk/core/submit.pyso thatcfn submit --helpand the documentation stay consistent.Verification
--use-docker/--no-dockerare implemented insrc/rpdk/core/submit.py(added in Add in no-docker and use-docker override to submit command #970).cfn submit --helpoutput to make sure the described semantics match the implementation.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.