Added docs Inventory Guide.

[vbotka]

SUMMARY

Add Inventory (Plugin) Guide

Guides
* community.general Filter Guide
* community.general Inventory (Plugin) Guide
* community.general Test (Plugin) Guide

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

NA

ADDITIONAL INFORMATION

NA

[ansibullbot]

The test ansible-test sanity --test no-smart-quotes [explain] failed with 1 error:

docs/docsite/rst/inventory_guide_iocage_aliases.rst:15:125: use ASCII quotes `'` and `"` instead of Unicode quotes

The test ansible-test sanity --test no-smart-quotes [explain] failed with 1 error:

docs/docsite/rst/inventory_guide_iocage_aliases.rst:15:125: use ASCII quotes `'` and `"` instead of Unicode quotes

The test ansible-test sanity --test no-smart-quotes [explain] failed with 1 error:

docs/docsite/rst/inventory_guide_iocage_aliases.rst:15:125: use ASCII quotes `'` and `"` instead of Unicode quotes

click here for bot help

[russoz]

I think @felixfontein 's line of thought makes sense, these guides should be put together as iocage guides, instead of using major categories for the types of the plugins. I am not going through the contents of the texts today, but I trust Felix's sharp eyes must have caught all (or most) of necessary adjustments. And if we pick something else later on we can always adjust later on.

[felixfontein]

I haven't checked all files in detail yet, I mainly skimmed over it and added comments for some things that seemed to happen more than once / I noticed on the first pass. I'll take a closer look later :)

[russoz]

Okie, I'll do the same - but not today

[vbotka]

... mark the command line as console and the output as bash

I changed the pygment to sh. Quoting man dhclient-script:

... check for the existence of /etc/dhclient-exit-hooks. If found, it will be sourced (see sh(1))

[vbotka]

For the record:

The file inventory_guide.rst serves the purpose of inventory_guide_iocage.rst temporary integration. Please remove the BOTMETA entry after you decide where to place it

docs/docsite/rst/inventory_guide.rst: {}

[vbotka]

For the record:

docs/docsite/rst/inventory_guide_iocage_aliases.rst:117:0: (ERROR/3) Unknown interpreted text role "ansvalue".

[felixfontein]

Yep, sorry, it's :ansval:, not :ansvalue:...

[vbotka]

For the record: ... disallowed language 'sh' found.

[vbotka]

For the record:

An AttributeError error occured. This is most probably due to a code block directive (code/code-block/sourcecode) without a specified language. This may result in a false negative for source: '/home/runner/work/community.general/community.general/.nox/docs-check/tmp/tmp7j736yzg/guide_iocage.rst'. The reason can also be another directive. For more information see the FAQ (https://rstcheck-core.rtfd.io/en/latest/faq) or the corresponding github issue: https://github.com/rstcheck/rstcheck-core/issues/3. 770 docs/docsite/rst/guide_iocage.rst:0:0: Unexpected error while parsing document: 'Values' object has no attribute 'env'

There are only two attribute env nobody complained before:

(env) > find docs/docsite/rst -name "iocage_inventory*" | xargs grep ':env'
docs/docsite/rst/iocage_inventory_guide_basics.rst:If iocage needs environment variable(s), use the option :ansopt:`community.general.iocage#inventory:env`. For example,
docs/docsite/rst/iocage_inventory_guide_dhcp.rst:Note: If the option :ansopt:`community.general.iocage#inventory:env` is used and :ansopt:`community.general.iocage#inventory:sudo` is enabled, enable also :ansopt:`community.general.iocage#inventory:sudo_preserve_env`. For example,

[felixfontein]

For the record: ... disallowed language 'sh' found.

The error message should list the allowed languages. Use shell instead of sh.

[ansibullbot]

@vbotka This PR was evaluated as a potentially problematic PR for the following reasons:

• More than 50 commits.

Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: #ansible-devel on Libera.chat IRC

click here for bot help

[felixfontein]

(Also please note that GitHub is hiding some of my comments by default, you have to expand them to see them. Or simply look at the "Files changed" view, where you can also commit multiple suggestions in one commit.)

[patchback[bot]]

Backport to stable-11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-11/563b29e12ab774814ff5171a454f3ef5948e99c8/pr-10239

Backported as https://github.com/ansible-collections/community.general/pull/10395

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

[felixfontein]

@vbotka thanks for your contribution! @russoz thanks for reviewing!