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

Add documentation stubs for undocumented module options #7738

Merged
merged 1 commit into from
Dec 20, 2023

Conversation

felixfontein
Copy link
Collaborator

SUMMARY

The consul and the manageiq_provider modules have a bunch of undocumented module options. Make sure that they at least show up in the documentation, and that it's clear they need more docs.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

consul
manageiq_provider

@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-7 backport-8 Automatically create a backport for the stable-8 branch labels Dec 17, 2023
@ansibullbot
Copy link
Collaborator

@ansibullbot ansibullbot added docs module module plugins plugin (any type) tests tests labels Dec 17, 2023
@felixfontein
Copy link
Collaborator Author

It would be great if someone who actually knows what these options do could help properly documenting them.

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Dec 20, 2023
@felixfontein felixfontein merged commit 0b0a302 into ansible-collections:main Dec 20, 2023
122 checks passed
Copy link

patchback bot commented Dec 20, 2023

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

❌ Failed to cleanly apply 0b0a302 on top of patchback/backports/stable-7/0b0a302855c0f71a530201532d781320f4930163/pr-7738

Backporting merged PR #7738 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-7/0b0a302855c0f71a530201532d781320f4930163/pr-7738 upstream/stable-7
  4. Now, cherry-pick PR Add documentation stubs for undocumented module options #7738 contents into that branch:
    $ git cherry-pick -x 0b0a302855c0f71a530201532d781320f4930163
    If it'll yell at you with something like fatal: Commit 0b0a302855c0f71a530201532d781320f4930163 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 0b0a302855c0f71a530201532d781320f4930163
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add documentation stubs for undocumented module options #7738 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-7/0b0a302855c0f71a530201532d781320f4930163/pr-7738
  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 deleted the docs2 branch December 20, 2023 06:32
Copy link

patchback bot commented Dec 20, 2023

Backport to stable-8: cherry-pick succeeded

Backport PR branch: patchback/backports/stable-8/0b0a302855c0f71a530201532d781320f4930163/pr-7738

PR branch created, proceeding with making a PR.

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

patchback bot pushed a commit that referenced this pull request Dec 20, 2023
Add documentation stubs for undocumented module options.

(cherry picked from commit 0b0a302)
@felixfontein felixfontein added backport-8 Automatically create a backport for the stable-8 branch and removed backport-8 Automatically create a backport for the stable-8 branch labels Dec 20, 2023
Copy link

patchback bot commented Dec 20, 2023

Backport to stable-8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-8/0b0a302855c0f71a530201532d781320f4930163/pr-7738

Backported as #7750

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

patchback bot pushed a commit that referenced this pull request Dec 20, 2023
Add documentation stubs for undocumented module options.

(cherry picked from commit 0b0a302)
felixfontein added a commit that referenced this pull request Dec 20, 2023
…documented module options (#7750)

Add documentation stubs for undocumented module options (#7738)

Add documentation stubs for undocumented module options.

(cherry picked from commit 0b0a302)

Co-authored-by: Felix Fontein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8 Automatically create a backport for the stable-8 branch docs module module plugins plugin (any type) tests tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants