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

consul modules: update documentation #56408

Merged
merged 6 commits into from May 16, 2019

Conversation

Projects
None yet
4 participants
@pilou-
Copy link
Contributor

commented May 14, 2019

SUMMARY

consul modules: update documentation

  • Python 2.6 is always required on managed node
  • document all types
  • consul modules: improve parameter descriptions
  • consul_acl: fix comment ('port' is an int)
  • consul_kv: add doc for retrieve parameter
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

consul, consul_acl, consul_kv

ADDITIONAL INFORMATION

cc @acozine

@ansibot

This comment has been minimized.

Copy link
Contributor

commented May 14, 2019

@pilou- pilou- changed the title consul modules: update documentation [WIP] consul modules: update documentation May 14, 2019

@ansibot ansibot added the WIP label May 14, 2019

pilou- added some commits May 14, 2019

consul modules: improve parameter descriptions
- acronyms: use upper case
- s/indentifying/identifying/
- don't mention choices
- use formatting functions

@pilou- pilou- force-pushed the pilou-:doc_consul_modules branch from 02cc9f1 to 7228b60 May 14, 2019

@pilou-

This comment has been minimized.

Copy link
Contributor Author

commented May 14, 2019

Sanity check fails:

17:37 ERROR: Found 1 validate-modules issue(s) which need to be resolved:
17:37 ERROR: lib/ansible/modules/clustering/consul_kv.py:0:0: E309 version_added for new option (retrieve) should be '2.9'. Currently StrictVersion ('0.0') (75%)

but retrieve parameter has been added many versions ago.

@mattclay could the sanity result be ignored ?

@pilou- pilou- changed the title [WIP] consul modules: update documentation consul modules: update documentation May 14, 2019

@mattclay

This comment has been minimized.

Copy link
Member

commented May 14, 2019

@pilou- Yes, once the PR is ready to merge we can ignore that error, assuming it's the only one.

@acozine

This comment has been minimized.

Copy link
Contributor

commented May 16, 2019

Thanks @pilou- for improving the docs and removing those CI exceptions.

I confirmed that the version-added mismatch was the only failure.

Merging in spite of the failed state of CI.

@acozine acozine merged commit 98246f6 into ansible:devel May 16, 2019

1 check failed

Shippable Run 122769 status is FAILED.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.