Skip to content
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 #53479

Merged
merged 11 commits into from
Mar 7, 2019

Conversation

hannseman
Copy link
Contributor

@hannseman hannseman commented Mar 7, 2019

SUMMARY

Fixes a number of issues:

  • mode choices is now validated and documented. Documentation about recreation of service is now correctly under this option and not publish.mode
  • Update and extend examples
  • Some test fixes
  • Update module return value sample with correct fields
  • Add secrets and users to module return value

BTW @felixfontein I love these new fast tests!

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

docker_swarm_service

@ansibot
Copy link
Contributor

ansibot commented Mar 7, 2019

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 bug This issue/PR relates to a bug. cloud community_review In order to be merged, this PR must follow the community review workflow. docker module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. support:community This issue/PR relates to code supported by the Ansible community. test This PR relates to tests. labels Mar 7, 2019
@felixfontein
Copy link
Contributor

felixfontein commented Mar 7, 2019

This PR is pretty hard to read. Can you split it up into two PRs:

  1. the first one with everything but docs reordering,
  2. the second one only docs reordering (but no changes)?

That would make reviewing the PRs much easier.

@hannseman
Copy link
Contributor Author

@felixfontein good idea. I'll create a PR with the reordering once this is merged.

@@ -461,7 +465,6 @@
mode:
description:
- What publish mode to use.
- Service will be removed and recreated when changed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this no longer true for publish mode?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was never true. In #52634 I added that string to the wrong mode-option.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's supposed to be documented on the actual mode-option and not publish.mode.

@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Mar 7, 2019
Copy link
Contributor

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shipit

Copy link
Contributor

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shipit

@ansibot ansibot added shipit This PR is ready to be merged by Core and removed community_review In order to be merged, this PR must follow the community review workflow. labels Mar 7, 2019
@sivel sivel merged commit 3d07e72 into ansible:devel Mar 7, 2019
@hannseman
Copy link
Contributor Author

@felixfontein thank you for reviewing. @sivel thank you for merging.

@felixfontein
Copy link
Contributor

@hannseman and thanks for the PR! :) Looks like #53482 needs a rebase now...

@hannseman hannseman deleted the docker_swarm_service-doc-fixes branch March 11, 2019 19:23
@ansible ansible locked and limited conversation to collaborators Jul 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.8 This issue/PR affects Ansible v2.8 bug This issue/PR relates to a bug. cloud docker module This issue/PR relates to a module. shipit This PR is ready to be merged by Core support:community This issue/PR relates to code supported by the Ansible community. test This PR relates to tests.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants