Correct Errors in Documentation #50507
Merged
Conversation
This file contains 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
According to the module, "compose" is not required, but the docs said it was - removed the "required" tag. Additionally, the example for removing a stack did not include the required "name" option (this method is why "compose" is not required. +label: docsite_pr
sivel
reviewed
Jan 3, 2019
Corrected issue to my "correction" on the description.
ansibot
added
affects_2.8
|
LGTM |
|
@unrinfosec thanks for improving the Ansible docs! Our guidelines call for removing |
acozine
reviewed
Jan 3, 2019
ansibot
added
needs_ci
ansibot
removed
needs_ci
felixfontein
approved these changes
Jan 4, 2019
ansibot
added
automerge
|
@sivel @danihodovic @acozine @DBendit thanks for your reviews and comments! I'll create a backport PR for stable-2.7. |
|
Ok, that wasn't necessary, we just added this module for 2.8... ;-) |
dagwieers
added
the
docsite_pr
kbreit
pushed a commit
to kbreit/ansible
that referenced
this pull request
Jan 11, 2019
* Correct Errors in Documentation According to the module, "compose" is not required, but the docs said it was - removed the "required" tag. Additionally, the example for removing a stack did not include the required "name" option (this method is why "compose" is not required. +label: docsite_pr * Removed change to description Corrected issue to my "correction" on the description. * Removed required false * Removed all instances of required: false.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
According to the module, "compose" is not required, but the docs said it was - removed the "required" tag. Additionally, the example for removing a stack did not include the required "name" option (this method is why "compose" is not required.
+label: docsite_pr
SUMMARY
There were some errors in the documentation that did not match what the module required.
ISSUE TYPE
COMPONENT NAME
docker_stack.py
ADDITIONAL INFORMATION
Just minor changed to documentation.