-
Notifications
You must be signed in to change notification settings - Fork 23.7k
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
Docs - Split Developing collections page, add info on optional module_utils #74105
Conversation
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Split LGTM at a glance, as does the changed intro paragraph for the optional module_utils. One minor clarification probably needed on the module_utils stuff, but otherwise +1 from me.
else: | ||
module.fail_json('respawn is not available in Ansible < 2.11, ensure that foopkg is installed') | ||
|
||
The optional module_utils behavior also applies to module imports from collections. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reading this back, it could be incorrectly interpreted that we're allowing imports of Ansible modules from collections. Maybe reword to something like:
The optional module_utils behavior also applies to module imports from collections. | |
The optional import behavior also applies to module_utils imported from collections. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @nitzmahone for the review. I changed the line number in a different edit, so the suggestion is "outdated" and I can't commit it from here. I implemented this exact change in 4b03edc.
The test
|
Review suggestion implemented in 4b03edc. Thanks @nitzmahone.
docs/docsite/rst/dev_guide/developing_collections_contributing.rst
Outdated
Show resolved
Hide resolved
docs/docsite/rst/dev_guide/developing_collections_migrating.rst
Outdated
Show resolved
Hide resolved
bd5b76f
to
30e2c37
Compare
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
30e2c37
to
2129d68
Compare
Rebased and ready for final review. |
The test
|
…_utils (ansible#74105) * (cherry picked from commit c90922e)
* Add description for COLLECTIONS_SCAN_SYS_PATH (#74351) Fixes: #74275 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 567361b) * lighten navigation background to make section labels easier to read for core docs (#74356) * make section labels for /ansible-core/ docs easier to read, with black text and lighter gray background (cherry picked from commit 6119fb0) * Correct splitext() description, and example (#74377) `splitext()` returns a 2-tuple of strings, and the last element of the return value includes the `.` (cherry picked from commit c295de6) * Using "~" instead of "+" for concatination (#74364) Changed FAQ examples to conform with the Jinja documentation: If both values on either side of a plus/+ are numbers, they will be added whereas using "~" will convert all operands into strings and then concatenate them. Closes #73799. (cherry picked from commit e6a5245) * Docs - Split Developing collections page, add info on optional module_utils (#74105) * (cherry picked from commit c90922e) * Add weos4 network platform to documentation (#74088) * Add weos4 network platform to documentation * Fix small format issues (cherry picked from commit 7ca5ded) * Fix typo in Makefile (#74396) Fixed minor typo specfic -> specific (cherry picked from commit 4880fee) * Update complex_data_manipulation.rst (#72509) (cherry picked from commit c2985c4) * Update VMware library installation docs (#71219) Depending upon OS/distro, please use pip/pip3. (cherry picked from commit ddfc648) * Update AWS dev guides to use collections utils and fragments (#72312) (cherry picked from commit cf08c23) * Use is_boto3_error_code in 'standard' example (#72313) Use is_boto3_error_code in 'standard' example rather than e.response['Error']['Code'] (#72313) Co-authored-by: Sloane Hertel <shertel@redhat.com> (cherry picked from commit 63afb33) * Update Kubernetes collection name in docs (#74440) (cherry picked from commit 8d499bb) * Update argcomplete docs links on installation guide (#74410) Link on installation docs is outdated. Switch to currently docs at: https://kislyuk.github.io/argcomplete/ (cherry picked from commit f97787c) * fix spacing to fix header, reorg contributing page (#74421) Co-authored-by: John R Barker <john@johnrbarker.com> (cherry picked from commit 9d9b08b) * Update first_found documentation (#70502) * import_tasks do not work with loop, use use include_tasks instead * update documentation (cherry picked from commit bacede7) * Product-related updates. (#74454) (cherry picked from commit 34c9ed8) Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Alex Willmer <alex@moreati.org.uk> Co-authored-by: Hublerho <43293510+Hublerho@users.noreply.github.com> Co-authored-by: Ernst Oudhof <17832702+ernst-s@users.noreply.github.com> Co-authored-by: Hu Shuai <hus.fnst@cn.fujitsu.com> Co-authored-by: dhx-mike-palandra <45608336+dhx-mike-palandra@users.noreply.github.com> Co-authored-by: jakelevinez <31458570+jakelevinez@users.noreply.github.com> Co-authored-by: Mark Chappell <mchappel@redhat.com> Co-authored-by: Lidiane Taquehara <lidi.mayra@gmail.com> Co-authored-by: Alex Domoradov <alex.hha@gmail.com> Co-authored-by: Bill Nottingham <notting@redhat.com>
SUMMARY
The current page on Developing collections is very long. This PR splits it into a section.
It also adds a paragraph about using optional module utilities with try/except blocks so collections can support multiple versions of ansible/ansible-core.
Related to #73832 and #73423.
ISSUE TYPE
COMPONENT NAME
docs.ansible.com
collections