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.

Sign up for GitHub

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

Jump to bottom

consul: minor fixes in docs #5767

Merged
merged 3 commits into from
Jan 6, 2023
Merged

consul: minor fixes in docs #5767

merged 3 commits into from
Jan 6, 2023

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Jan 5, 2023

SUMMARY

Minor fixes in docs.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/modules/consul.py

@ansibullbot
Copy link
Collaborator

cc @sgargan
click here for bot help

@ansibullbot ansibullbot added clustering docs docs_only module module needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR plugins plugin (any type) labels Jan 5, 2023
@github-actions
Copy link

github-actions bot commented Jan 5, 2023 •
edited
Loading

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

@ansibullbot ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Jan 5, 2023
@russoz russoz changed the title consul: minor fixes in docs [WIP] consul: minor fixes in docs Jan 5, 2023
@russoz
Copy link
Collaborator Author

russoz commented Jan 5, 2023 •
edited
Loading

Do not merge yet, may have found other documentation issues.

  • All the time-related params used by the ConsulCheck class are validated and default to s if no unit is explicitly passed, however the docs seem to say they default to m (minutes).

  • Parameters script, ttl, tcp and http are effectively mutually exclusive (see comment https://github.com/ansible-collections/community.general/pull/4599/files#r862460844 for explanation why they are not marked as such in the module's argument_spec), but the documentation for them does not make it clear, and for parameter script it states that it

    requires interval and vice-versa

    which is not true since http and tcp also require interval.

@ansibullbot ansibullbot added the WIP Work in progress label Jan 5, 2023
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-5 labels Jan 5, 2023
@ansibullbot ansibullbot removed the needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI label Jan 5, 2023
@russoz russoz changed the title [WIP] consul: minor fixes in docs consul: minor fixes in docs Jan 5, 2023
@ansibullbot ansibullbot removed the WIP Work in progress label Jan 5, 2023
felixfontein
felixfontein reviewed Jan 5, 2023
View reviewed changes
plugins/modules/consul.py Outdated Show resolved Hide resolved
plugins/modules/consul.py Outdated Show resolved Hide resolved
plugins/modules/consul.py Outdated Show resolved Hide resolved
plugins/modules/consul.py Outdated Show resolved Hide resolved
@felixfontein felixfontein merged commit 217a62a into ansible-collections:main Jan 6, 2023
@patchback
Copy link

patchback bot commented Jan 6, 2023 •
edited
Loading

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/217a62aca2aa673708621d1c963def9e068681e0/pr-5767

Backported as #5770

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Jan 6, 2023
patchback bot pushed a commit that referenced this pull request Jan 6, 2023
@russoz @patchback
consul: minor fixes in docs (#5767)
42ec327 
* consul: minor fixes in docs

* additional docs fixes

* adjustments from review

(cherry picked from commit 217a62a)
@patchback patchback bot mentioned this pull request Jan 6, 2023
Merged
@patchback
Copy link

patchback bot commented Jan 6, 2023 •
edited
Loading

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/217a62aca2aa673708621d1c963def9e068681e0/pr-5767

Backported as #5771

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@felixfontein
Copy link
Collaborator

@russoz thanks!

patchback bot pushed a commit that referenced this pull request Jan 6, 2023
@russoz @patchback
consul: minor fixes in docs (#5767)
204c3ce 
* consul: minor fixes in docs

* additional docs fixes

* adjustments from review

(cherry picked from commit 217a62a)
@patchback patchback bot mentioned this pull request Jan 6, 2023
Merged
felixfontein pushed a commit that referenced this pull request Jan 6, 2023
@patchback @russoz
[PR #5767/217a62ac backport][stable-5] consul: minor fixes in docs (#…
f2c08be 
…5770)

consul: minor fixes in docs (#5767)

* consul: minor fixes in docs

* additional docs fixes

* adjustments from review

(cherry picked from commit 217a62a)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
felixfontein pushed a commit that referenced this pull request Jan 6, 2023
@patchback @russoz
[PR #5767/217a62ac backport][stable-6] consul: minor fixes in docs (#…
c8b8668 
…5771)

consul: minor fixes in docs (#5767)

* consul: minor fixes in docs

* additional docs fixes

* adjustments from review

(cherry picked from commit 217a62a)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
@russoz russoz deleted the consul-fix-docs branch January 6, 2023 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@felixfontein felixfontein felixfontein approved these changes

Assignees
No one assigned
Labels
clustering docs_only docs module module plugins plugin (any type)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@russoz @ansibullbot @felixfontein