6487a239c0
developing_inventory sample code: fix undefined var "results" if get_option(cache)=False ( #72977 )
...
if user_cache_setting == False, then the previous code didn't parse the inventory source
4 years ago
e5ccd18be4
Wording changes to docs ( #70082 )
4 years ago
57c2cc7c77
correct the reST rendering of the R() note ( #72896 )
4 years ago
0a7fcd135c
Docsite: update "Migrating Ansible content to a different collection" info ( #72710 )
...
* add a reminder about ignore-*.txt entries, fix formatting, add symlink removal note
* Update docs/docsite/rst/dev_guide/developing_collections.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: David Moreau Simard <moi@dmsimard.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
a57539f764
Update VMware module development ( #72603 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
1937dd5e9c
Update developing_plugins.rst ( #72305 )
...
##### SUMMARY
ansible_date_time returns utc time. datetime.utcnow() rather than datetime.now()
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
4 years ago
ddad9930aa
Clarify collection paths in docs ( #72510 )
...
* Clarify collection paths in docs, fix rst syntax, rephrase docs about using collection from folder/local git
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
da1c1e8bb8
Add info on how to contribute to **community**-maintained collections as well. ( #72494 )
4 years ago
01d207a3e3
Improve argument spec documentation ( #72335 )
...
* Link to argument spec documentation from 'Creating a module'.
* Use items instead of sub-headings.
* Update deprecation information.
* Document conditional requirements.
* Document supports_check_mode and add_file_common_args.
* Add deprecation examples.
* Re-add word.
* Improve title.
* Fix RST formatting, add conditional dependency section starter.
4 years ago
c20329a0f6
Update migrating_roles.rst ( #72260 )
...
Fix a typo in the sample spec file Source0 line
4 years ago
d18901dd4a
Update HTTP -> HTTPS ( #72244 )
...
Co-authored-by: Ronald Eddy Jr <ron@Ronalds-MacBook-Pro.local>
4 years ago
caba47dd3f
Add support for GSSAPI/Kerberos to urls.py ( #72113 )
...
* Add support for GSSAPI/Kerberos to urls.py
* Test out changes with the latest test container
* Get remote hosts working
* Fix up httptester_krb5_password reader
* Fix tests for opensuse and macOS
* Hopefully last lot of testing changes
* Dont do CBT on macOS
* Fixes from review
4 years ago
2b79cd2c0f
Fix typos ( #72072 )
4 years ago
a077bca5d5
ansible-test: improve version number validation, validate some semantic versioning properties ( #71679 )
...
* Validate removal versions.
* Validate that removal collection versions and version_added collection versions conform to semver spec.
* Validate removal version numbers in meta/runtime.yml.
* Stricter validation for isodates (f.ex. YYYY-M-D is not allowed).
* Improve error reporting.
* Validate removal collection versions.
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
4 years ago
94522b7c10
Fix typos ( #71970 )
4 years ago
c1005147e0
doc: add vmware_rest_guidelines
...
Add the development guidelines for the vmware_rest collection.
4 years ago
4f990e7615
dev_guide: Add Pygments Lexer examples ( #71458 )
...
* dev_guide: Add Pygments Lexer examples
Fixes : #51307
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
* adds ansible-output lexer, remmoves unsupported lexers
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
2655fc0c23
Docsite: update Migrating Ansible content to a different collection ( #71854 )
...
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
a80131a283
Docsite: misc fixes ( #71697 )
4 years ago
7048542199
Fix passing the connection timeout to connection plugins ( #71722 )
...
* Fix passing the connection timeout to connection plugins
4 years ago
7a0e545700
Add how to run unit test link in testing_units_modules doc ( #71523 )
...
* Add how to run unit test link in testing_units_modules
* Fix sanity test
4 years ago
1a06587f3b
Fix typo in the documentation ( #71701 )
...
Fix typo in the documentation: casting instead of casing
4 years ago
73bed95ead
Docsite: add reference to Style guide ( #71694 )
4 years ago
a34043c6be
Changed all_modules references to list_of_collections in the documentation ( #71656 )
4 years ago
1ad0f666d5
Fix typo in documentation ( #71652 )
...
Fix typo on the page about unit testing modules,
4 years ago
bbd4ec13f1
clarify that collection names use same requirements as namespaces ( #71639 )
4 years ago
7bfeed3e24
Docsite: replace Latin phrases to English ( #71588 )
...
Replace Latin phrases like "e.g." and "i.e." and "etc." with English phrases.
* Update docs/docsite/rst/community/committer_guidelines.rst
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst
* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst
* Update docs/docsite/rst/dev_guide/module_lifecycle.rst
* Update docs/docsite/rst/user_guide/intro_inventory.rst
* Update docs/docsite/rst/user_guide/playbooks_loops.rst
* Update docs/docsite/rst/user_guide/playbooks_reuse.rst
* Update docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst
* Update docs/docsite/rst/dev_guide/testing.rst
* Update docs/docsite/rst/dev_guide/testing_integration.rst
* Update docs/docsite/rst/porting_guides/porting_guide_2.5.rst
* Update docs/docsite/rst/reference_appendices/faq.rst
4 years ago
bfba0ffc45
Docsite: improve developing_modules_documenting.rst ( #71590 )
...
* Docsite: improve developing_modules_documenting.rst
* add necessary dots to returns descriptions
4 years ago
cda5854099
Docsite: improve spelling_word_choice.rst ( #71592 )
4 years ago
29b20bd1b1
DOCS: Mentions ansible-base, adds collections pointers to Community and Dev Guides ( #71480 )
4 years ago
56423b1648
testing_sanity.rst: add argument for running in docker ( #71223 )
4 years ago
bc6461432e
Add --allow-disabled to sanity docs ( #71524 )
4 years ago
addee0699e
quick update to changelog instructins ( #71492 )
4 years ago
2b7461eb52
fix broken links due to master -> main branch rename ( #71426 )
4 years ago
5498b0bb71
Documentation: improve dev_guide/testing_integration.rst ( #71370 )
4 years ago
b82889eef5
Add note about integration tests for new modules to the dev guide ( #71345 )
4 years ago
74f88c56a5
quick fix to change main back to devel ( #71342 )
...
* quick fix to change main back to devel
* Update docs/docsite/rst/dev_guide/developing_collections.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
ea58d7c233
Make it so callback plugins can act on implicit/explicit meta tasks ( #71009 )
...
Change:
- Now sends meta tasks to the task start callback
- Lets callback plugins opt-in to receiving implicit tasks
Test Plan:
- New integration tests
Tickets:
- Indirectly fixes #71007 by allowing custom callbacks with this data
Signed-off-by: Rick Elrod <rick@elrod.me>
4 years ago
4f993922c8
Add documentation about info/facts module development ( #71250 )
...
Fixes : #40151
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
180507c62b
dev_guide: improve developing_collections.rst ( #71332 )
4 years ago
606604bb97
Add warning about copyright year change ( #71251 )
...
To simplify project administration and avoid any legal issues,
add a warning in the docs. This reflects - https://github.com/ansible/ansible/issues/45989#issuecomment-423635622 and fixes : #45989
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
ecd3b52ad7
Writing style updates to Developing dynamic inventory topic ( #71245 )
...
* modified the writing style
* incorporated peer feedback
4 years ago
ecea018506
Fix 404 links ( #71256 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
a496b89d6f
overview_architecture.rst: fix playbook example ( #71303 )
4 years ago
9296ee9329
developing_modules_in_groups.rst: add note about releasing ( #71305 )
4 years ago
7195788ffe
updates per writing style ( #70978 )
...
* updated to follow IBM and Ansible style guides
* modified heading underlines
* incorporated peer review feedback
4 years ago
fb144c4414
Update ansible doc formats ( #71070 )
...
* Fix tty_ify bugs and refactor
* Move tty_ify() and supporting attributes to the DocCLI class as that's
the only thing using it.
* Add unittest for the code.
* Fix a bug where the substitution macros can be detected when they are
a part of another word.
* Add support for L(), R(), and HORIZONTALLINE which were added to the
website docs many years ago.
* Update test/units/cli/test_doc.py
Co-authored-by: Matt Clay <matt@mystile.com>
Co-authored-by: Matt Clay <matt@mystile.com>
4 years ago
a9eb8b0488
Add some documentation for the format of meta/runtime.yml ( #71035 )
...
* Document the format of meta/runtime.yml
* Document multiple Ansible versions
Clarify difference between deprecation and tombstone fields
* add note
4 years ago
7f62a9d7b5
Make cache adjudicator's flush call plugin flush ( #70987 )
...
Change:
- Previously CachePluginAdjudicator#flush only removed entries from the
cache backend that it knew about by using them earlier. Now it calls
the underlying plugin's flush() method.
Test Plan:
- New unit tests
Tickets:
- Fixes #68770
Signed-off-by: Rick Elrod <rick@elrod.me>
4 years ago
0c855dc70b
Guide users to use ansible-runner ( #71063 )
...
Update the docs to guide users to use `ansible-runner` instead of using Python API directly. In many use cases, executing Ansible playbooks are sufficient. In those use cases, `ansible-runner` is easier and much stable to use comparing with Python API, but there is no mention of it.
4 years ago
azrdev