Skip to content

Update documentation #10696

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
Merged
merged 7 commits into from
Aug 23, 2025
Merged

Update documentation #10696

merged 7 commits into from
Aug 23, 2025

Conversation

bofo540
Copy link
Contributor

@bofo540 bofo540 commented Aug 18, 2025

Added to the description explaining the mode of operation and the protocol being used.
This would add to the user experience and saves time for the user.

@bofo540
Update documentation
cea4d41 
Added to the description explaining the mode of operation and the protocol being used.
This would add to the user experience and saves time for the user.
@ansibullbot
Copy link
Collaborator

cc @tbielawa @tgoetheyn
click here for bot help

@ansibullbot ansibullbot added docs_only module module new_contributor Help guide this first time contributor plugins plugin (any type) small_patch Hopefully easy to review labels Aug 18, 2025
@ansibullbot

This comment was marked as outdated.

Sign in to view
@ansibullbot ansibullbot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Aug 18, 2025
@ansibullbot ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Aug 18, 2025
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-10 Automatically create a backport for the stable-10 branch backport-11 Automatically create a backport for the stable-10 branch labels Aug 18, 2025
felixfontein
felixfontein reviewed Aug 18, 2025
View reviewed changes
Copy link
Collaborator

@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.

Thanks for your contribution!

@bofo540 @felixfontein
Apply suggestions from code review
ae1118b 
Co-authored-by: Felix Fontein <felix@fontein.de>
@ansibullbot ansibullbot removed the small_patch Hopefully easy to review label Aug 19, 2025
@bofo540 bofo540 requested a review from felixfontein August 19, 2025 14:39
felixfontein
felixfontein reviewed Aug 19, 2025
View reviewed changes
bofo540 and others added 2 commits August 20, 2025 08:54
@bofo540 @felixfontein
added trailing comma to nagios.cfg path listing
ddbec1e 
Co-authored-by: Felix Fontein <felix@fontein.de>
@bofo540 @felixfontein
added trailing period after icinga path listing.
341b475 
Co-authored-by: Felix Fontein <felix@fontein.de>
@bofo540 bofo540 requested a review from felixfontein August 20, 2025 07:06
@felixfontein felixfontein merged commit db7757e into ansible-collections:main Aug 23, 2025
134 checks passed
@patchback Patchback
Copy link

patchback bot commented Aug 23, 2025 •
edited
Loading

Backport to stable-10: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply db7757e on top of patchback/backports/stable-10/db7757ed4b9a232776f5afd0e38c9d0cc73970e9/pr-10696

Backporting merged PR #10696 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it: 
    $ git remote add upstream https://github.com/ansible-collections/community.general.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code: 
    $ git fetch upstream
$ git checkout -b patchback/backports/stable-10/db7757ed4b9a232776f5afd0e38c9d0cc73970e9/pr-10696 upstream/stable-10
  4. Now, cherry-pick PR Update documentation #10696 contents into that branch: 
    $ git cherry-pick -x db7757ed4b9a232776f5afd0e38c9d0cc73970e9
    If it'll yell at you with something like fatal: Commit db7757ed4b9a232776f5afd0e38c9d0cc73970e9 is a merge but no -m option was given., add -m 1 as follows instead: 
    $ git cherry-pick -m1 -x db7757ed4b9a232776f5afd0e38c9d0cc73970e9
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Update documentation #10696 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/stable-10/db7757ed4b9a232776f5afd0e38c9d0cc73970e9/pr-10696
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @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 Aug 23, 2025
@patchback Patchback
Copy link

patchback bot commented Aug 23, 2025 •
edited
Loading

Backport to stable-11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-11/db7757ed4b9a232776f5afd0e38c9d0cc73970e9/pr-10696

Backported as #10714

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

@felixfontein
Copy link
Collaborator

@bofo540 thanks for your contribution!

patchback bot pushed a commit that referenced this pull request Aug 23, 2025
@bofo540 @bjt-user
@felixfontein @patchback
Update documentation (#10696)
3df65bc 
* Update documentation

Added to the description explaining the mode of operation and the protocol being used.
This would add to the user experience and saves time for the user.

* use single quotes around colon contained list element to satisfy linter

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

* documentation of nagios module - included all nagios configuration paths in plugins/modules/nagios.py

* used italic code I(...) for paths

* added trailing comma to nagios.cfg path listing

Co-authored-by: Felix Fontein <felix@fontein.de>

* added trailing period after icinga path listing.

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: bjt-user <bjoern.foersterling@web.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit db7757e)
@patchback patchback bot mentioned this pull request Aug 23, 2025
Merged
felixfontein added a commit that referenced this pull request Aug 23, 2025
@patchback @bofo540
@bjt-user @felixfontein
[PR #10696/db7757ed backport][stable-11] Update documentation (#10714)
89e6e6c 
Update documentation (#10696)

* Update documentation

Added to the description explaining the mode of operation and the protocol being used.
This would add to the user experience and saves time for the user.

* use single quotes around colon contained list element to satisfy linter

* Apply suggestions from code review



* documentation of nagios module - included all nagios configuration paths in plugins/modules/nagios.py

* used italic code I(...) for paths

* added trailing comma to nagios.cfg path listing



* added trailing period after icinga path listing.



---------



(cherry picked from commit db7757e)

Co-authored-by: bofo540 <bjoern.foersterling@cpb-software.com>
Co-authored-by: bjt-user <bjoern.foersterling@web.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
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
backport-10 Automatically create a backport for the stable-10 branch backport-11 Automatically create a backport for the stable-10 branch docs_only module module new_contributor Help guide this first time contributor plugins plugin (any type)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bofo540 @ansibullbot @felixfontein @bjt-user