-
Notifications
You must be signed in to change notification settings - Fork 23.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docker_swarm_service: Documentation fixes #50861
docker_swarm_service: Documentation fixes #50861
Conversation
The test
|
ready_for_review |
changelogs/fragments/50861-docker_swarm_service-documentation-fixes.yml
Outdated
Show resolved
Hide resolved
Anyway, you might also be interested in the Ansible Docker WG; see ansible/community#408 for some infos. Feel free to post ideas there or just subscribe to it to find out what's going on. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM shipit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM shipit
@hannseman Thank you for this improvement |
* Describe labels and container_labels correctly * Clarify reserve_memory and limit_memory docs * Remove default from container_labels doc * Remove trailing whitespace * Document min api version for configs and secrets * Add changelog fragment * Specify type on labels and container_labels * Consolidate required API version descriptions * Update reserve and limit memory docs * Use correct power-of-two units * Remove description about limit_memory minimum 4mb (cherry picked from commit 644057e)
Thanks everyone! I created a backport PR in #50873. |
* Describe labels and container_labels correctly * Clarify reserve_memory and limit_memory docs * Remove default from container_labels doc * Remove trailing whitespace * Document min api version for configs and secrets * Add changelog fragment * Specify type on labels and container_labels * Consolidate required API version descriptions * Update reserve and limit memory docs * Use correct power-of-two units * Remove description about limit_memory minimum 4mb (cherry picked from commit 644057e)
* Describe labels and container_labels correctly * Clarify reserve_memory and limit_memory docs * Remove default from container_labels doc * Remove trailing whitespace * Document min api version for configs and secrets * Add changelog fragment * Specify type on labels and container_labels * Consolidate required API version descriptions * Update reserve and limit memory docs * Use correct power-of-two units * Remove description about limit_memory minimum 4mb
SUMMARY
This PR fixes three issues in the documentation.
secrets
andconfigs
.labels
andcontainer_labels
are described as they accept lists but in reality they expect dicts.limit_memory
andreserve_memory
describes that they accept values in "MB" but in reality it is in bytes if not suffixed by unit identifiers.ISSUE TYPE
COMPONENT NAME
docker_swarm_service