Commit graph

562 commits

Author SHA1 Message Date
Jordan Borean
caba47dd3f
Add support for GSSAPI/Kerberos to urls.py ()
* 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
2020-10-13 14:16:07 +10:00
Erik Zettel
2b79cd2c0f
Fix typos () 2020-10-02 10:32:03 -04:00
Felix Fontein
a077bca5d5
ansible-test: improve version number validation, validate some semantic versioning properties ()
* 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>
2020-09-29 13:33:45 -07:00
Jorge Vallecillo
94522b7c10
Fix typos () 2020-09-28 14:33:24 -04:00
Gonéri Le Bouder
c1005147e0 doc: add vmware_rest_guidelines
Add the development guidelines for the vmware_rest collection.
2020-09-25 12:24:48 -04:00
Abhijeet Kasurde
4f990e7615
dev_guide: Add Pygments Lexer examples ()
* dev_guide: Add Pygments Lexer examples

Fixes: 

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>
2020-09-24 15:00:17 -05:00
Andrew Klychkov
2655fc0c23
Docsite: update Migrating Ansible content to a different collection ()
Co-authored-by: Felix Fontein <felix@fontein.de>
2020-09-24 14:19:04 -04:00
Andrew Klychkov
a80131a283
Docsite: misc fixes () 2020-09-15 16:01:49 -04:00
Sloane Hertel
7048542199
Fix passing the connection timeout to connection plugins ()
* Fix passing the connection timeout to connection plugins
2020-09-15 11:34:11 -04:00
Amin Vakil
7a0e545700
Add how to run unit test link in testing_units_modules doc ()
* Add how to run unit test link in testing_units_modules
* Fix sanity test
2020-09-10 15:21:01 -05:00
Guillaume Vincent
1a06587f3b
Fix typo in the documentation ()
Fix typo in the documentation: casting instead of casing
2020-09-10 10:49:59 -05:00
Andrew Klychkov
73bed95ead
Docsite: add reference to Style guide () 2020-09-10 10:17:13 -04:00
esmersmith
a34043c6be
Changed all_modules references to list_of_collections in the documentation () 2020-09-09 11:43:40 -05:00
Zois Pagoulatos
1ad0f666d5
Fix typo in documentation ()
Fix typo on the page about unit testing modules,
2020-09-09 11:41:43 -05:00
Sandra McCann
bbd4ec13f1
clarify that collection names use same requirements as namespaces () 2020-09-04 14:37:44 -05:00
Andrew Klychkov
7bfeed3e24
Docsite: replace Latin phrases to English ()
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
2020-09-03 14:47:57 -05:00
Andrew Klychkov
bfba0ffc45
Docsite: improve developing_modules_documenting.rst ()
* Docsite: improve developing_modules_documenting.rst

* add necessary dots to returns descriptions
2020-09-02 09:26:42 -04:00
Andrew Klychkov
cda5854099
Docsite: improve spelling_word_choice.rst () 2020-09-02 09:24:53 -04:00
Alicia Cozine
29b20bd1b1
DOCS: Mentions ansible-base, adds collections pointers to Community and Dev Guides () 2020-09-01 12:25:37 -04:00
Andrew Klychkov
56423b1648
testing_sanity.rst: add argument for running in docker () 2020-09-01 12:00:13 -04:00
Amin Vakil
bc6461432e
Add --allow-disabled to sanity docs () 2020-08-31 10:46:03 -05:00
Sandra McCann
addee0699e
quick update to changelog instructins () 2020-08-27 11:05:35 -05:00
Patrick Reader
2b7461eb52
fix broken links due to master -> main branch rename () 2020-08-24 15:39:21 -04:00
Andrew Klychkov
5498b0bb71
Documentation: improve dev_guide/testing_integration.rst () 2020-08-20 15:24:22 -04:00
Andrew Klychkov
b82889eef5
Add note about integration tests for new modules to the dev guide () 2020-08-20 10:15:08 -04:00
Sandra McCann
74f88c56a5
quick fix to change main back to devel ()
* 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>
2020-08-19 15:26:12 -05:00
Rick Elrod
ea58d7c233
Make it so callback plugins can act on implicit/explicit meta tasks ()
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  by allowing custom callbacks with this data

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-18 16:56:48 -05:00
Abhijeet Kasurde
4f993922c8
Add documentation about info/facts module development ()
Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-18 15:56:43 -04:00
Andrew Klychkov
180507c62b
dev_guide: improve developing_collections.rst () 2020-08-18 12:07:27 -04:00
Abhijeet Kasurde
606604bb97
Add warning about copyright year change ()
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: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-17 15:44:06 -05:00
Sayee
ecd3b52ad7
Writing style updates to Developing dynamic inventory topic ()
* modified the writing style

* incorporated peer feedback
2020-08-17 14:16:19 -05:00
Abhijeet Kasurde
ecea018506
Fix 404 links ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-17 13:52:45 -04:00
Andrew Klychkov
a496b89d6f
overview_architecture.rst: fix playbook example () 2020-08-17 13:44:05 -04:00
Andrew Klychkov
9296ee9329
developing_modules_in_groups.rst: add note about releasing () 2020-08-17 13:43:15 -04:00
Sayee
7195788ffe
updates per writing style ()
* updated to follow IBM and Ansible style guides
* modified heading underlines
* incorporated peer review feedback
2020-08-10 17:39:34 -05:00
Toshio Kuratomi
fb144c4414
Update ansible doc formats ()
* 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>
2020-08-05 10:53:25 -07:00
Sloane Hertel
a9eb8b0488
Add some documentation for the format of meta/runtime.yml ()
* Document the format of meta/runtime.yml

* Document multiple Ansible versions

Clarify difference between deprecation and tombstone fields

* add note
2020-08-04 11:25:08 -04:00
Rick Elrod
7f62a9d7b5
Make cache adjudicator's flush call plugin flush ()
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 

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-03 17:16:15 -05:00
EthanHur
0c855dc70b
Guide users to use ansible-runner ()
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.
2020-08-03 10:15:37 -05:00
Sandra McCann
58145dff9c
document how to migrate between collections ()
* document how to migrate between collections
* Apply suggestions from code review

Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
2020-07-30 15:51:53 -05:00
Sam Doran
7f0c84ea15
Update module debugging docs ()
- Combine remote and local debugging instructions.
- Update the example code to match current AnsiballZ structure and behavior
- Change reference name and update references
- Clarify how PYTHON path is modified
- Also add note about other remote debugging tools.

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-07-29 12:14:49 -04:00
Sandra McCann
748ba96610
How to use rst :ref: for modules in collections () 2020-07-28 17:40:16 -05:00
Felix Fontein
7e2cc7db12
validate-modules: fix version_added validation for top-level, fix error codes ()
* Also validate top-level version_added.

* Fix error code.

* Produce same version_added validation error in schema than in code (and stop returning it twice).

* Return correct error codes for invalid version_added for options and return values.

* Add changelog.

* Fix forgotten closing braket.

* Accept 'historical' for some top-level version_added.
2020-07-28 10:10:35 -05:00
Sviatoslav Sydorenko
20bb915092
Refactor Python API examples and docs
PR : it's a follow-up for .

It includes a merge of `examples/scripts/uptime.py` and a similar
code snippet from `docs/docsite/rst/dev_guide/developing_api.rst`.

This patch also changes the docs RST file to include contents of
the example file instead of holding a copy of a similar code.
2020-07-23 18:24:02 +02:00
David Shrewsbury
bf98f031f3
Sanitize URI module keys with no_log values ()
* Add sanitize_keys() to module_utils.

* More robust tests

* Revert 69653 change

* Allow list or dict

* fix pep8

* Sanitize lists within dict values

* words

* First pass at uri module

* Fix insane sanity tests

* fix integration tests

* Add changelog

* Remove unit test introduced in 69653

* Add ignore_keys param

* Sanitize all-the-things

* Ignore '_ansible*' keys

* cleanup

* Use module.no_log_values

* Avoid deep recursion issues by using deferred removal structure.

* Nit cleanups

* Add doc blurb

* spelling

* ci_complete
2020-07-22 14:49:37 -05:00
Sayee
1733253297
Modification of 'Adding modules and plugins locally' topic ()
* Remediated the topic to comply with IBM style guide and minimalism practices
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-07-22 11:59:18 -05:00
Baptiste Mille-Mathias
92e16c2838
Few fixes for reference_appendices/faq.html ()
* Format using `` instead of `, add line breaks for long lines, rephrase or remove useless text.
Move some text.

* Add clearer version of OpenSSh is affected by SCP bug

* Review some pages using ansible doc writing guide.
2020-07-20 13:43:39 -05:00
Stef B
fb3db170cc
Make Sources, Plugins sections easier to read ()
Re-wrote the Inventory Sources section and also the next section to have shorter, clearer sentences with a more active voice.
2020-07-20 13:30:06 -05:00
Alicia Cozine
f1f782fc37
partial update of community docs to reflect collections transition () 2020-07-14 15:47:18 -04:00
Abhijeet Kasurde
375c6b4ae4
docs: update date format in removed_at_date ()
removed_at_date requires YYYY-MM-DD format.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-07-14 11:43:25 -04:00
Abhijeet Kasurde
20209c508f
docs: update module development docs ()
Update module development docs for flattened modules directory.

Fixes:  (at least partially)

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-07-13 14:41:59 -05:00
Mark Chappell
e1ba7dc52a
Update AWS Integration test docmentation () 2020-07-08 08:01:37 +05:30
Baptiste Mille-Mathias
bd1378405b
Small documentation fixes ()
* Add type for options in the sample module shown in Developing Modules, as this is required to have the tests being
green
* Remove duplicated strings: the same sentence is in "Python tips" and "Module security", keeping the
latter.
2020-07-06 12:53:10 -05:00
Sviatoslav Sydorenko
8d97c8c222 Fix the internal Python API usage examples
Previous version initialized the `TaskQueueManager` after calling
`Play.load()` while advertising a way to inject a custom library
location path. This caused the tasks loader not to find any custom
modules because it was triggered before the path was actually added
to the module loader.

This patch changes the order of the operations to ensure that the
customized `context.CLIARGS` actually influences things.

Resolves https://github.com/ansible/ansible/issues/69758.
2020-07-03 10:44:54 +02:00
Michael Ritsema
82e5d03bdb
Suggest ansible ad-hoc command while developing module ()
If a local module has no documentation, the doc command will fail without any hints of what is wrong. Add another way to confirm the presence of a local module.
* Update docs/docsite/rst/dev_guide/developing_locally.rst

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-07-02 17:23:37 -05:00
Sandra McCann
5a28b2b86c
Add steps for how to create changelog.rst for a collection ()
* Update docs/docsite/rst/dev_guide/developing_collections.rst
* add steps to create changelogs, add sentence about not using the tool
* add note for rerunning the command

Co-authored-by: Felix Fontein <felix@fontein.de>
2020-06-29 14:22:31 -05:00
Sandra McCann
83f6e4850b
document FQCN for M() and :seealso: in DOCUMENTATION blocks ()
* document FQCN for M() in DOCUMENTATION blocks

* add note about c
2020-06-29 11:16:59 -05:00
Abhijeet Kasurde
da868d9d60
docs: Add note about ansible-doc ()
ansible-doc can only parse Python modules, added a note about
this is developer guide; Fixes: 
2020-06-19 14:28:02 -05:00
Jill R
0ef75f65d9
Fix broken link in AWS Guide ()
Point to collection rather than ansible/ansible for example.
2020-06-19 14:18:55 -05:00
Sandra McCann
c9c8cd34b2
added documentation for R() ()
* Updated docs/docsite/rst/dev_guide/developing_modules_documenting.rst, added documentation for R()
* added link to how to add anchors, anchor, and clarification on when to use each option

Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-06-16 11:50:50 -05:00
Sandra McCann
2609482975
How to contribute to Ansible maintained collections ()
contributor info with HTML table
2020-06-15 15:38:42 -05:00
John R Barker
37785255f2
validate ansible-base's and collections runtime.yml ()
* Validate ansible-base & collection's runtime.yml

Add new test `runtime-metadata`

* Schema validation of file
* Error if a a legacy meta/routing.yml exist in a collection
* removal_date OR removal_version

* Add tombstone validation.

* Allow both ISO 8601 date strings and datetime.date objects (from YAML dates).

* Address review comments.

* Add metadata to test collection.

* Add requirements file.

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Matt Clay <matt@mystile.com>
2020-06-12 15:34:34 +01:00
Sandra McCann
524257a7b0
Document the ability to deprecate by date ()
* Document the ability to deprecate by date
* deprecated_in and deprecated_by_date are mutually exclusive
2020-06-11 15:28:24 -05:00
Felix Fontein
a114da80ee
Use antsibull-changelog instead of packaged changelog generator ()
Replace the ansible-base changelog linting and generation tool with antsibull-changelog and make it available for linting collections. Previously changelog linting was limited to ansible-base.
2020-06-11 11:21:21 -07:00
Alicia Cozine
d7c03e9fdb
Update testing collections to mention ansible-base versions ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-06-10 16:22:01 -04:00
Felix Fontein
a862ff2d43
Deprecation revisited ()
* Allow to specify collection_name separately for deprecation.

* Use new functionality in Ansible.

* Use new functionality in tests.

* Update tagging/untagging functions.

* Update pylint deprecated sanity test.

* Update validate-modules. Missing are basic checks for version_added (validate semantic version format for collections).

* Improve version validation. Re-add version_added validation.

* Make sure collection names are added to return docs before schema validation.

* Extra checks to avoid crashes on bad data.

* Make C# module utils code work, and update/extend tests.

* Add changelog fragment.

* Stop extracting collection name from potentially tagged versions/dates.

* Simplify C# code.

* Update Windows modules docs.

* Forgot semicolons.
2020-06-09 15:21:19 -07:00
usatosi
ff98ecc4d0
Update developing_modules_best_practices.rst ()
##### SUMMARY
wrong module path for module_utils.basic in developing_modules_best_practices.rst
2020-06-08 13:28:17 +05:30
Brian Coca
062e780a68
starting metadata sunset ()
* starting metadata sunset

 - purged metadata from any requirements
 - fix indent in generic handler for yaml content (whey metadata display was off)
 - make more resilient against bad formed docs
 - removed all metadata from docs template
 - remove metadata from schemas
 - removed mdata tests and from unrelated tests

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Rick Elrod <rick@elrod.me>
2020-06-04 21:01:46 -04:00
Sloane Hertel
e40889e711
Add support to install collections from git repositories ()
* Enable installing collections from git repositories

* Add tests for installing individual and multiple collections from git repositories

* Test to make sure recursive dependencies with different syntax are deduplicated

* Add documentation

* add a changelog

* Skip Python 2.6

* Only fail if no collections are located in a git repository

Add support for a 'type' key for collections in requirement.yml files.
Update the changelog and document the supported keys and allowed values for the type.

Add a note that the collection(s) in the repo must contain a galaxy.yml

* Add a warning about embedding credentials in SCM URLs

* Update with review suggestions

* suppress sanity compile failure for Python 2.6
2020-05-29 13:33:32 -04:00
Sandra McCann
c884c5fddf
add pointer to namespace and collection name restrictions () 2020-05-29 11:58:15 -05:00
Sandra McCann
3a4e227efa
remove build errors including guess ()
* remove build errors including guess

* fixed shippable errors
2020-05-29 11:56:49 -05:00
Jordan Borean
f81f5da20e
Ansible.Basic added generic fragment merger for module options () 2020-05-29 16:11:38 +10:00
Felix Fontein
40f21dfd3c
Version source tagging (automatic and manual) for version_added and deprecation versions ()
* Track collection for version_added.
Validate *all* version numbers in validate-modules.
For tagged version numbers (i.e. version_added), consider source collection to chose validation.

* Make tagging/untagging functions more flexible.

* Tag all versions in doc fragments.

* Tag all deprecation versions issued by code.

* Make Display.deprecated() understand tagged versions.

* Extend validation to enforce tagged version numbers.

* Tag versions in tests.

* Lint and fix test.

* Mention collection name in collection loader's deprecation/removal messages.

* Fix error IDs.

* Handle tagged dates in Display.deprecated().

* Also require that removed_at_date and deprecated_aliases.date are tagged.

* Also automatically tag/untag removed_at_date; fix sanity module removal version check.

* Improve error message when invalid version number is used (like '2.14' in collections).
2020-05-28 22:46:16 -07:00
Anatoly Pugachev
09f86c1410
docs: communications update ()
* add some more info on IRC support channels to docs
2020-05-28 15:12:24 -05:00
Felix Fontein
ea04e0048d
Allow to deprecate options and aliases by date ()
* Allow to deprecate options and aliases by date instead of only by version.

* Update display.deprecate().

* Adjust behavior to conform to tested behavior, extend tests, and improve C# style.

* Parse date and fail on invalid date.

This is mainly to make sure that people start using invalid dates, and we eventually have a mess to clean up.

* C# code: improve validation and update/extend tests.

* Make sure that deprecate() is not called with both date and version.

* Forgot to remove no longer necessary formatting.

* Adjust order of warnings in C# code.

* Adjust unrelated test.

* Fix grammar (and make that test pass).

* Don't parse date, and adjust message to be same as in .

* Sanity tests: disable date in past test.

* Validate-modules: validate ISO 8601 date format.

* Validate-modules: switch schema declaration for deprecated_aliases to improve error messages for invalid dates.

* Use DateTime instead of string for date deprecation.

* Validate that date in deprecated_aliases is actually a DateTime.

* Fix tests.

* Fix rebasing error.

* Adjust error codes for pylint, and add removed_at_date and deprecated_aliases.date checks to validate-modules.

* Make deprecation date in the past error codes optional.

* Make sure not both version and date are specified for AnsibleModule.deprecate() calls.

* Stop using Python 3.7+ API.

* Make sure errors are actually reported. Re-add 'ansible-' prefix.

* Avoid crashing when 'name' isn't there.

* Linting.

* Update lib/ansible/module_utils/csharp/Ansible.Basic.cs

Co-authored-by: Jordan Borean <jborean93@gmail.com>

* Adjust test to latest change.

* Prefer date over version if both end up in Display.deprecated().

Co-authored-by: Jordan Borean <jborean93@gmail.com>
2020-05-26 20:23:56 -04:00
Felix Fontein
0e15375ffe
Add deprecated removed_in_version and deprecated_aliases version tests () 2020-05-13 13:58:09 -07:00
Gonéri Le Bouder
e70f5cc132
vmware: example should use FQCN ()
For instance, you should use `community.vmware.vmware_guest` instead of just
`vmware_guest`.

This way, the examples don't depend on the `collections` directive of the
playbook.

Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-05-11 16:27:20 -04:00
Serienmorder
366f808683
Correct debugging modules documentation () 2020-05-06 12:20:47 -05:00
Sloane Hertel
34458f3569
Update inventory caching documentation () 2020-05-05 15:10:57 -05:00
Sandra McCann
caa263e2cf
Document how to migrate a standalone role to a collection ()
Adds docs for role developers/owners in the collections ecosystem
2020-05-04 15:59:54 -05:00
Felix Fontein
abb807e5dd
Extend dev guide for collection testing and collection hacking ()
* Make clear which BOTMETA.yml is meant (some collections also have one), fix itemization, document /rebuild and /rebuild_failed, add section on how to test collections with ansible-test, update supported versions for compile tests, add a section on hacking collections, implement feedback. 

* Update docs/docsite/rst/dev_guide/developing_collections.rst

Co-Authored-By: Felix Fontein <felix@fontein.de>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-04-15 15:51:19 -05:00
Andrew Klychkov
598ead965d
Dev guide: add notes about different image types for integration and unit/sanity tests ()
* Dev guide: add notes about different image types for integration and unit/sanity tests
* Update docs/docsite/rst/dev_guide/testing_integration.rst

Co-authored-by: Matt Clay <matt@mystile.com>
2020-04-07 09:17:44 -05:00
Ken Dreyer
318d5606c1
doc: explain default "required" value for argument_spec () 2020-04-06 16:07:30 -04:00
Sandra McCann
8042d226e4
fix make webdocs warnings () 2020-03-25 13:13:56 -05:00
Sandra McCann
02e36fbfc2
fix broken link in developing collections () 2020-03-25 13:07:03 -05:00
Matt Davis
ed9de94ad9
remove azure extras and extras_require support ()
* remove azure extras and extras_require support

* Since Azure will be collectionized, the requirements will float more frequently than Ansible releases; the Azure collection needs to host the requirements now.
* Removed the dynamic extras support as well, since Azure was the only thing using it. If we need it again, it's easy to pull back from history.

* Mark azure-requirements as orhpaned.

This keeps the docs around so that existing links from old test runs remain valid.

Co-authored-by: Matt Clay <matt@mystile.com>
2020-03-23 13:07:33 -07:00
Alicia Cozine
69543b47c9 fix last 7 docs errors on post-migration test runs ()
* address toc-tree-glob-pattern-no-match errors

* address Include-file-not-found error

* address 2.10 porting guide errors, add warning to page

* updates individual plugin type pages

* Add ignores.

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Matt Clay <matt@mystile.com>
2020-03-23 11:14:21 -05:00
Abhijeet Kasurde
a4da73e961
misc typo fixes ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-02-26 10:58:39 -05:00
Alicia Cozine
75191c1484
fixes link, makes intrapage TOC local () 2020-02-24 14:29:22 -05:00
Andrew Klychkov
244277addd
dev_guide/developing_modules_best_practices.rst: fix typo () 2020-02-21 10:56:35 +00:00
Andrew Klychkov
907c98ebcd
/docs/docsite/rst/dev_guide: fix typos () 2020-02-21 10:56:12 +00:00
Felix Fontein
4373863f25
Module validation: sanity check mutually_exclusive, required_if, required_xxx ... ()
* required_if checks should have three or four parts.

* Validate mutually_exclusive, required_together, required_one_of, required_if and required_by.

* Simplify code.

* Improve messages.

* Add changelog.

* Sanity check.

* Update docs.

* Update ignore.txt.

* Don't continue with tests when terms are not strings.

* Remove ignore.txt entry.

* Make sure validate-modules doesn't choke on things already flagged by schema test.

* Check required_if requirements list for strings.
2020-02-19 12:26:42 -05:00
John R Barker
4844adff9a
Collection developer guide - BOTMETA ()
* Docs: Improve how to migrate and create collections
* Update docs/docsite/rst/dev_guide/developing_collections.rst

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-02-19 10:11:38 -06:00
Abhijeet Kasurde
b6753b46a9
Replace 'message' in module parameters ()
* 'message' parameter is replaced by 'commit_message' in grafana_dashboard
* 'message' parameter is replaced by 'notification_message' in datadog_monitor

This change is required since 'message' as parameter name is used internally by
Ansible core engine.

Fixes:    

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-02-18 13:00:16 +01:00
Sandra McCann
a60feeb3c1
Specify lowercase only for Galaxy namespaces ()
* specify lowercase only for galaxy namespaces
* doh... include meta file
2020-02-17 15:26:47 -06:00
Adam Miller
98c1fc9d3a
add a testing section to collections dev guide ()
Signed-off-by: Adam Miller <admiller@redhat.com>
2020-02-14 16:57:24 -06:00
Sandra McCann
a6bb3ae291
fix some broken links () 2020-02-12 10:47:00 -06:00
Roger D. Winans
888a059ee7
Can we simplify _How to test a PR_? ()
Switch the instructions on testing PRs to use the `refs/pull/XXXX/head` refspec as described in [_Checking out pull requests locally_](https://help.github.com/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally#modifying-an-inactive-pull-request-locally).
2020-02-11 15:53:23 -06:00
Wojciech Sciesinski
49e7f9afe2
Link the testing documentation to the module documenting page () 2020-02-10 15:30:04 -05:00
Sandra McCann
4dd2513371
add info on creating doc fragments in a collection ()
* add info on creating doc fragments in a collection
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-02-10 10:23:28 -06:00