Joshua Kelley
484a671c5e
Fixes broken links. For the github links this was where references to in the URL are stale due to the default branch in the linked repository now being . While github does have the functionality of dropping you on the default branch (via an HTTP 302 redirect) when it does not recognize the branch you are trying to reach, the fact that most of these links work is more of a coincidence than reliance on a github feature. Also removes unnecessary whitespace where found. ( #78638 )
3 years ago
Sloane Hertel
5ac40b358d
fix adhoc dev example ( #78593 )
3 years ago
Sandra McCann
045f30371f
fix Ansible 2.14 reference ( #78589 )
3 years ago
Ian Wienand
1e6730aec4
docs: Update managed node requirements ( #78468 )
3 years ago
Matt Martz
deb54e4c5b
Relax minimal config to enable manifest functionality ( #78574 )
...
* Revert "Fix incorrect docs about how to enable manifest functionality (#78572 )"
This reverts commit ac1ca40fb3 .
3 years ago
Matt Martz
ac1ca40fb3
Fix incorrect docs about how to enable manifest functionality ( #78572 )
3 years ago
Matt Martz
d2f8099118
Use MANIFEST.in style directives to build collections ( #78422 )
3 years ago
Sandra McCann
7ae1eabaa4
clarify collection signature not available from Community Galaxy ( #78386 )
3 years ago
Alex
69c7e3f4a3
update the documentation for the _collection init_ command ( #78404 )
3 years ago
Felix Fontein
2218b63aef
Fix typo: missing 'install'. ( #78448 )
3 years ago
Felix Fontein
733a767948
Add basic docs on how to create a collection docsite with antsibull-docs. ( #78387 )
3 years ago
Ian Wienand
f5cac6bc5d
docs: Fix control node reference links ( #78424 )
3 years ago
Muhammad Rafly Andrianza
0f688f07af
update the out-of-date ansible-test sanity ignores ( #78342 )
3 years ago
Desmond Obisi
c9a341902b
Document choice to use Ansible Project in copyright lines ( #78164 )
...
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
3 years ago
Desmond Obisi
6ddccc1604
Adding applicable licensing requirements ( #78162 )
3 years ago
Mario Lenz
048adac5b7
Migrate vmware.vmware_rest Dev Guide to collection ( #78255 )
3 years ago
Lewis Brogan
561cf1956d
Docsite: Updated style guide resources ( #78048 )
4 years ago
Mario Lenz
0ff1ba3e12
Move AWS guidelines to collection ( #77959 )
4 years ago
Martin Krizek
39b3581316
Deprecate non lists lookups ( #77875 )
4 years ago
Mario Lenz
b69eb28ed2
Migrate community.vmware Dev Guide to collection ( #77723 )
4 years ago
Sandra McCann
f3c684564c
Remove platform dev guides from core docs ( #77915 )
4 years ago
Mario Lenz
9923e92d97
Fix plugin dev examples ( #77759 )
...
* Fix plugin dev examples
* Update docs/docsite/rst/dev_guide/developing_plugins.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
Sandra McCann
5e22fe21fd
stub out ovirt dev guide with pointer to new location ( #77751 )
4 years ago
Desmond Obisi
42086c14a3
Updated the playbook section in this docs ( #77747 )
4 years ago
Matt Davis
d352f2ec21
core branch descriptions ( #76152 )
4 years ago
Kristian Heljas
52bd59c481
Docs: `ansible-test sanity` example with a folder
...
##### SUMMARY
The docs mentions explicitly that you can run the tests against certain files which might not relay that it works on folders too!
Let's make this clear :)
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
4 years ago
Brian Coca
255745b3e6
simplify developing modules ( #77647 )
4 years ago
Sandra McCann
ef2fe6823c
add collection pr review checklist ( #77661 )
...
Co-authored-by: Emmanuel Ugwu <32464178+ugwutotheeshoes@users.noreply.github.com>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
4 years ago
Brian Coca
2fc73a9dc3
update python devel docs ( #77499 )
...
* update python devel docs
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Emmanuel Ugwu
538a19b748
Update developing_collections_structure.rst ( #77496 )
4 years ago
Emmanuel Ugwu
eef0a1cef9
Update developing_collections_shared.rst ( #77497 )
...
##### SUMMARY
Use of the meta/runtime.yml file to specify the ansible-core version for collections
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
4 years ago
Sandra McCann
8caa6efaab
add links.yml to collection structure docs ( #77415 )
...
* add links.yml to collection structure docs
* fix link
* Update docs/docsite/rst/dev_guide/developing_collections_structure.rst
4 years ago
Sandra McCann
21827522dc
Add quickstart testing docs for collections ( #77290 )
...
Co-authored-by: Divine Odazie <dodazie@gmail.com>
Co-authored-by: Emmanuel Ugwu <32464178+ugwutotheeshoes@users.noreply.github.com>
4 years ago
Jasmine Hegman
1a923e307e
After 2.10 Collections can use vars plugins ( #77216 )
4 years ago
lumean
1ba3ead0a0
Update developing_modules_general_aci.rst ( #73925 )
4 years ago
Matt Clay
3d5637beec
Initial mypy sanity test support for core.
4 years ago
Sandra McCann
8291dbdf81
add accessibility guidelines to docs style guide ( #77145 )
...
Co-authored-by: Jill R <4121322+jillr@users.noreply.github.com>
4 years ago
Sandra McCann
5f258d2c64
move collection pr quickstart over ( #77087 )
...
* move collection pr quickstart over
* add link
* fix CI
* fix formatting
4 years ago
Sandra McCann
b2bafc054e
remove list of container images ( #77089 )
...
* remove list of container images
* remove some more centos8
4 years ago
Sandra McCann
af7c9deb4e
add crosslinks for changelog fragments ( #77022 )
4 years ago
Joe Zollo
bc5672d9ba
Update developing_modules_general_windows.rst ( #76846 )
4 years ago
Sandra McCann
e9af4195be
update ansible.legacy docs ( #76839 )
...
* update ansible.legacy docs
* correct role description
* Update docs/docsite/rst/dev_guide/developing_locally.rst
* Update docs/docsite/rst/dev_guide/developing_locally.rst
4 years ago
Sandra McCann
cfe4bdc1b9
Create separate core vs collection contributor guides ( #76764 )
...
* updated core guides
* ansible package docs guides
* add core guide to Ansible docs
* Update docs/docsite/rst/community/maintainers.rst
4 years ago
Sandra McCann
665e3dc629
remove outdated note on limitations of R() in module docs ( #76736 )
4 years ago
Jordan Borean
4c738b08b4
Add docs on Windows module util requirements ( #76583 )
4 years ago
Jordan Borean
7dd22b8b4b
Update Windows host requirements ( #76582 )
4 years ago
Kian Meng, Ang
e5967c02f5
Fix typos in docs ( #76526 )
4 years ago
Edward Hilgendorf
d0de3d3dc2
change keyword return to results ( #76515 )
...
value is getting associated to python keyword return
4 years ago
Andrew Klychkov
60d094db73
Docsite/dev_guide: add note about ansible-test utility installation ways ( #76128 )
...
* Docsite/dev_guide: add note about ansible-test utility installation
* Add link to Testing Ansible page
4 years ago
nemobis
0360728b7f
Fix typo in docs for "globbing" ( #76324 )
...
Constent with the rest of the documentation including fileglob.
4 years ago
Matt Clay
bb63c97c16
ansible-test - Update import test and sanity requirements. ( #76308 )
...
* Add script to freeze sanity requirements.
* Declare sanity test requirements and freeze
* Use pinned requirements for import.plugin test.
* Expand scope of import test for ansible-core.
* Add ignores for galaxy import errors.
* Update test-constraints sanity test.
4 years ago
Felix Fontein
a734da5e82
Restore documentation on M() and R() ( #76284 )
...
* Undo most of bf9944266c , add note on where R() does not work.
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
4 years ago
Felix Fontein
fe77bc9e3c
Validate some markup in documentation in validate-modules ( #76262 )
...
* Validate some markup in documentation.
* Add changelog fragment.
* Use urlparse instead of URL regex.
* Document new error code.
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
4 years ago
Felix Fontein
a861cb5607
ansible-core 2.12 dropped support for galaxy.yaml. ( #76179 )
4 years ago
Sebastian Wiesinger
1b43298316
Update dev guide for vars plugins in collections ( #75861 )
4 years ago
Matthew Donoughe
d17f9a523d
Docs: fedora32 is no longer supported (for integration tests) ( #76159 )
4 years ago
Aine Riordan
e0e6464873
Docs: Fix text for contributing to collection link ( #76174 )
4 years ago
Richard Megginson
360a3d2431
Clarify that "requires_ansible" means Ansible Core ( #76100 )
...
Clarify that the `requires_ansible` field in meta/runtime.yml refers to the version of Ansible Core (ansible-core), not any package called "ansible" e.g. https://pypi.org/project/ansible/
4 years ago
Brian Scholer
4abc669c24
Update module documentation about ref links ( #76088 )
...
* Update module documentation about ref links
4 years ago
Samuel Gaist
19fce0527a
docs - Use code-block to format code examples in Developer Guide ( #75849 )
...
Fixes #75663
4 years ago
Brian Scholer
f4cdea9645
docs - add some info on plugin option source precedence ( #75754 )
...
* docs - add some info on plugin option source precedence
##### SUMMARY
Add some clarity on precedence, especially from sources of the same type.
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
* update RST formatting
* Update docs/docsite/rst/dev_guide/developing_plugins.rst
Apply review suggestions
Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>
Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>
4 years ago
Matt Clay
4ea8d9a782
ansible-test - split controller/target testing ( #75605 )
4 years ago
Aine Riordan
2346f93961
Docs: Fix section header notation in Style Guide ( #75720 )
4 years ago
Aine Riordan
17122edfc5
Docs: Fix section header notation in Developer Guide ( #75721 )
4 years ago
Jon Pugh
b1527dcf63
Small typo in vars plugin example. ( #75702 )
4 years ago
Erik Zettel
c2fa71c4e8
Fix various typos in documentation ( #75662 )
...
* docs/docsite/rst/dev_guide/developing_modules_general_aci.rst: fix typos
* docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst: fix typos
* docs/docsite/rst/dev_guide/testing_units_modules.rst: fix typos
* docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_2.0.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_2.10.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_2.4.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_3.rst: fix typos
* docs/docsite/rst/porting_guides/porting_guide_4.rst: fix typos
* docs/docsite/rst/reference_appendices/glossary.rst: fix typos
* docs/docsite/rst/reference_appendices/release_and_maintenance.rst: fix typos
* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/collect_information.rst: fix typos
* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/vm_tool_information.rst: fix typos
* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos
* docs/docsite/rst/user_guide/playbooks_debugger.rst: fix typos
* docs/docsite/rst/user_guide/playbooks_filters.rst: fix typos
* docs/docsite/rst/user_guide/windows_performance.rst: fix typos
* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos
4 years ago
Brian Coca
8af54a0355
Added info about playbooks for collection ( #75535 )
...
*
4 years ago
Sloane Hertel
e5f6c2d141
Fix rekey_on_member when key is undefined ( #75131 )
...
* Fix rekey_on_member when key is undefined and add a test case
* Add documentation about error handling in filter and test plugin sections
4 years ago
Matt Clay
99a79e1969
ansible-test - Move code from _data to _util. ( #75495 )
...
* Update paths to match relocated files.
* Update ansible-test symlink paths.
* Update path classification.
* Update MANIFEST.in
* Update sanity test context paths.
* Update sanity ignores.
* Update shebang sanity test.
* Update configure-remoting-ps1 sanity test.
* Update BOTMETA.yml to reflect new paths.
* Update paths in collection loader comments.
* Update Makefile for ansible-test.
* Update docs.
* Add changelog fragment.
4 years ago
Sandra McCann
394860560a
remove core docs build warnings ( #75496 )
4 years ago
Alicia Cozine
d652b19e11
Docs: clarify dir names for local plugins ( #75157 )
...
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Alicia Cozine
3c3e30a610
Docs: Add Matrix as a chat option ( #75406 )
4 years ago
Alicia Cozine
13c28664ae
Docs: talk about AWX or the Platform, not Tower ( #74952 )
...
* updates Tower page to talk about RHAAP
* updates scenario guide Tower references
* updates Tower references to use AWX and/or RHAAP
* more scenario guides fixes
* fix CI failures
* Update docs/docsite/rst/porting_guides/porting_guide_2.8.rst
* removes tower link
* for 2.8, still mention Tower along with AWX and RHAAP
* aws guides should be updated in the collection, where they now exist
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Alicia Cozine
0e9d1ab1cc
incorporate minimalism feedback on distributing collections page ( #75266 )
4 years ago
Sloane Hertel
3b861abce1
add action_groups support to collections ( #74039 )
...
* Canonicalize module_defaults actions and action_groups pre-fork and cache them on the play
* Call get_action_args_with_defaults with the resolved FQCN plugin and don't pass the redirect list
* Add validation for action_group metadata and a toggle to disable the warnings
* Handle groups recursively referring to each other
* Remove special-casing for non-fqcn actions in module_defaults groups
* Error for actions and groups in module_defaults that can't be resolved
* Error for fully templated module_defaults
* Add integration tests for action_groups
* Changelog
4 years ago
Andrew Klychkov
f8bb182589
developing_collections_testing: Fix formatting ( #75233 )
4 years ago
Christian Adell
3ba2243ba3
Replace self.module by my_module ( #75196 )
...
While implementing basic Ansible module testing I realised that the `self.module` used in some places is not actually a thing, and I changed to `my_module` to make it work as I understand it was expected.
4 years ago
Andreas Olsson
2eb9921b19
Prefer https:// links in the docs site ( #75121 )
...
This is a follow-up of previous years' 1a11cec and c8315bf . It deals
with links which at that point presumably either were not present or
did not support https://
5 years ago
Sandra McCann
ea0ba7bf30
update terminology based on recent IBM Style Guide word list ( #75089 )
5 years ago
Brian Coca
6fd61bb19f
add option def/handling to lookup ( #74495 )
5 years ago
Alicia Cozine
605b1a1c5c
documents community 'extra docs' option in collections ( #74886 )
...
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
5 years ago
Abhijeet Kasurde
8d39332c3d
plugins: specify plugin types for get_option ( #74799 )
5 years ago
Toshio Kuratomi
80e7e1a17c
Due to the takeover of freenode we're moving to a different irc network. ( #74775 )
...
* Due to the takeover of freenode we're moving to a different irc network.
* Our channels updated to point at the same channel name on libera.chat
* Some links went to webchat.freenode.net. At this time, libera.chat
doesn't point you to an official webchat client so I changed these to
https://libera.chat . (kiwi irc does work with libera.chat so that
could be another option).
* In general, I used the name irc.libera.net for link names and
https://libera.chat for link targets. This is because the irc service
is hosted on irc.libera.chat but the project web server is hosted on
libera.chat. (This appears to also be true for freenode but we were
using http://irc.freenode.net which doesn't seem to work. Oops).
* Removed http://irc.freenode.net from the linkcheck exceptions.
linkcheck was actually correct to flag that as invalid (should have
been http://frenode.net instead).
* Looks like hte important people in #yaml are now in libera.chat
* Link to where contributors should get help
Add a link target and then link to where contributors should get support
for developing groups of modules.
* Update docs/docsite/rst/dev_guide/developing_modules_in_groups.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
5 years ago
Abhijeet Kasurde
a61821b626
misc typos ( #74724 )
5 years ago
Sandra McCann
ef0055a806
add anchors ( #74825 )
...
LGTM @samccann
5 years ago
Sean Cavanaugh
88d67b00f8
Update developing_collections_distributing.rst ( #74820 )
...
It is not clear that you can publish without configuring an ansible.cfg. The `--token` can be displayed with the `ansible-galaxy collection publish -h`
5 years ago
Abhijeet Kasurde
870f943365
docs: Update Python 2 doc links ( #74633 )
...
* docs: Update Python 2 doc links
Update links from Python 2 to Python 3
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
* use docs.python.com/3/ everywhere, except onethat should remain 2.6
* refer to python 3 in module docs and comments
* format two python docs links as list
* updates links in unwanted.py test file
* per matt clay, this should link to python 2
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
5 years ago
Lydie
bf9944266c
Issue 73792: Removed mentions of R() and M() ( #74708 )
...
* 73792: Removed mentions of R and M
5 years ago
Jill R
fa15d35cb1
Update AWS guides with new SDK and Python requirements ( #74585 )
...
The 2.0 collection releases will introduce new Python requirements
and a new SDK support policy
5 years ago
Mark Mercado
1906d75907
Adding DigitalOcean cloud support to ansible-test ( #74222 )
5 years ago
Felix Fontein
a6cc508822
Update the module lifecycle document to also cover plugins and collections ( #74413 )
...
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Matt Clay
8bd599d048
Change Shippable refs in docs to Azure Pipelines.
5 years ago
Matt Clay
a30c55f68a
Remove deprecated `common.removed` module_util.
...
Tests have been updated to reflect its removal as well.
5 years ago
Mark Chappell
c387b318a6
AWS: update reference to auto-retrying ResourceNotFound ( #72314 )
...
AWS Dev Guidelines: update reference to auto-retrying ResourceNotFound
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Bill Nottingham
34c9ed8a28
Product-related updates. ( #74454 )
5 years ago
Alicia Cozine
9d9b08bece
fix spacing to fix header, reorg contributing page ( #74421 )
...
Co-authored-by: John R Barker <john@johnrbarker.com>
5 years ago
Abhijeet Kasurde
8d499bbc83
Update Kubernetes collection name in docs ( #74440 )
5 years ago
Mark Chappell
63afb33d86
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>
5 years ago
Mark Chappell
cf08c23b4f
Update AWS dev guides to use collections utils and fragments ( #72312 )
5 years ago
Alicia Cozine
c90922ee36
Docs - Split Developing collections page, add info on optional module_utils ( #74105 )
...
*
5 years ago