Skip to content

Update documentation examples - #16497

Open
calzone-cannoli wants to merge 2 commits into
ansible:develfrom
calzone-cannoli:devel
Open

Update documentation examples#16497
calzone-cannoli wants to merge 2 commits into
ansible:develfrom
calzone-cannoli:devel

Conversation

@calzone-cannoli

@calzone-cannoli calzone-cannoli commented Jun 10, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
SUMMARY

Updated the examples in documentation for a few modules that were out of date or incorrect

ISSUE TYPE
  • Bug, Docs Fix or other nominal change
COMPONENT NAME
  • Docs
STEPS TO REPRODUCE AND EXTRA INFO

Summary by CodeRabbit

  • Documentation
    • Updated module usage examples to improve clarity and consistency in documentation across the collection.

@github-actions github-actions Bot added the component:awx_collection issues related to the collection for controlling AWX label Jun 10, 2026
@coderabbitai

coderabbitai Bot commented Jun 10, 2026 •
edited
Loading

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 0741737b-cfcd-4a80-8862-380ec5c949b1

📥 Commits

Reviewing files that changed from the base of the PR and between d5e5ea3 and 8edde14.

📒 Files selected for processing (5)
  • awx_collection/plugins/modules/controller_meta.py
  • awx_collection/plugins/modules/credential_type.py
  • awx_collection/plugins/modules/instance.py
  • awx_collection/plugins/modules/instance_group.py
  • awx_collection/plugins/modules/workflow_job_template_node.py
📝 Walkthrough

Walkthrough

This PR updates module documentation examples across five AWX collection plugins to standardize naming, structure, and module references. Changes include adding named example blocks, normalizing task keys from qualified module paths to short names, and replacing legacy tower_* module references with current module names.

Changes

Module Examples Normalization

Layer / File(s) Summary
Example format and naming standardization
awx_collection/plugins/modules/controller_meta.py, awx_collection/plugins/modules/credential_type.py, awx_collection/plugins/modules/instance_group.py		 controller_meta EXAMPLES updated to use a named block; credential_type adds explicit create/remove example headings; instance_group adds a new create instance group example.
Task key and legacy module name updates
awx_collection/plugins/modules/instance.py, awx_collection/plugins/modules/workflow_job_template_node.py		 instance examples rekeyed from awx.awx.instance: to instance:; workflow_job_template_node examples updated from legacy tower_workflow_job_template* module names to current workflow_job_template_node module name.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating documentation examples across multiple modules. It is concise, specific, and clearly summarizes the primary purpose of the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

community component:awx_collection issues related to the collection for controlling AWX

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@calzone-cannoli