Skip to content

Commit a333e16

Browse files
committed
docs(plugins, tools/build-docs): correct version_added, expose api_key_file default, restructure docs nav
Three review-driven fixes after eyeballing the rendered docs site at https://linuxfabrik.github.io/lfops/. version_added audit Cross-checked every plugin's `version_added` against the actual first release tag that shipped the file. Five entries were wrong: * `lvm_pv`: claimed `11.0.0` (does not exist), really shipped in v6.0.0. * `nextcloud_occ_app` / `nextcloud_occ_app_config` / `nextcloud_occ_system_config`: claimed `2.0.1`, really shipped in v6.0.0. * `combine_lod` filter: claimed `2.0.1`, really shipped in v3.0.0. The nine UptimeRobot modules carried `6.1.0`, which doesn't exist either; moved them to `6.0.2` (latest released v6.0.1 plus one patch level), the realistic next-release placeholder until the actual release decision is made. UptimeRobot api_key_file default The argument_spec carried no default for `api_key_file`, so the rendered docs (and `ansible-doc`) both showed an empty Default column even though the runtime resolver in `module_utils/uptimerobot.py` falls back to `~/.uptimerobot`. Set `default='~/.uptimerobot'` on the argument across all nine modules and lift the existing "Default C(~/.uptimerobot)" from the description into the proper YAML `default:` field. Behaviour is unchanged: explicit `api_key`, then `api_key_file` (now always populated with at least the default), then `UPTIMEROBOT_API_KEY` env var. Verified with a no-op `--check` against the 038 inventory: 0 changed. Docs site nav The previous nav wrapped "Home / Compatibility / Playbooks / Security / Contributing" inside a section also called "Linuxfabrik LFOps", which duplicated the site_name banner in the left sidebar. Flatten those five entries to the top level. Plugins are now grouped properly: Plugins: Modules: <every modules/*.py with a DOCUMENTATION block> Lookup: <bitwarden_item> Filter: <combine_lod> That removes the awkward `bitwarden_item (lookup)` / `(filter)` suffixes the flat layout needed for disambiguation.
1 parent 6e3ceaf commit a333e16

170 files changed

Lines changed: 494 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.pre-commit-config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ repos:
3434
- '--severity-level=low'
3535
- '--confidence-level=low'
3636
- '--skip=B110,B112,B311' # graceful-degradation patterns, non-crypto randomness
37+
# `plugins/modules/ipa*.py` is vendored ansible-freeipa code; bandit
38+
# false-positives on the project's own code style (`shell=dict(...)`
39+
# in argument_spec triggers B604, the literal `'on_create'` sentinel
40+
# triggers B105). Out of scope for in-tree review.
41+
exclude: '^plugins/modules/ipa.*\.py$'
3742
types_or: ['python']
3843

3944
- repo: 'https://github.com/jendrikseipp/vulture'

plugins/modules/ipagroup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
---
3838
module: ipagroup
3939
short_description: Manage FreeIPA groups
40+
version_added: "6.0.0"
4041
description: Manage FreeIPA groups
4142
extends_documentation_fragment:
4243
- ipamodule_base_docs

plugins/modules/ipahbacrule.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
---
3838
module: ipahbacrule
3939
short_description: Manage FreeIPA HBAC rules
40+
version_added: "6.0.0"
4041
description: Manage FreeIPA HBAC rules
4142
extends_documentation_fragment:
4243
- ipamodule_base_docs

plugins/modules/ipahostgroup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
---
3939
module: ipahostgroup
4040
short_description: Manage FreeIPA hostgroups
41+
version_added: "6.0.0"
4142
description: Manage FreeIPA hostgroups
4243
extends_documentation_fragment:
4344
- ipamodule_base_docs

plugins/modules/ipapwpolicy.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
---
3939
module: ipapwpolicy
4040
short_description: Manage FreeIPA pwpolicies
41+
version_added: "6.0.0"
4142
description: Manage FreeIPA pwpolicies
4243
extends_documentation_fragment:
4344
- ipamodule_base_docs

plugins/modules/ipasudocmd.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
---
4040
module: ipasudocmd
4141
short_description: Manage FreeIPA sudo command
42+
version_added: "6.0.0"
4243
description: Manage FreeIPA sudo command
4344
extends_documentation_fragment:
4445
- ipamodule_base_docs

plugins/modules/ipasudocmdgroup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
---
4040
module: ipasudocmdgroup
4141
short_description: Manage FreeIPA sudocmd groups
42+
version_added: "6.0.0"
4243
description: Manage FreeIPA sudocmd groups
4344
extends_documentation_fragment:
4445
- ipamodule_base_docs

plugins/modules/ipasudorule.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
---
3939
module: ipasudorule
4040
short_description: Manage FreeIPA sudo rules
41+
version_added: "6.0.0"
4142
description: Manage FreeIPA sudo rules
4243
extends_documentation_fragment:
4344
- ipamodule_base_docs

plugins/modules/ipauser.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
---
3838
module: ipauser
3939
short_description: Manage FreeIPA users
40+
version_added: "6.0.0"
4041
description: Manage FreeIPA users
4142
extends_documentation_fragment:
4243
- ipamodule_base_docs

plugins/modules/sqlite_query.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
---
1515
module: sqlite
1616
short_description: Run SQLite queries
17+
version_added: "2.0.0"
1718
description:
1819
- Runs arbitrary SQLite queries.
1920
options:

0 commit comments

Comments
 (0)