Commit Graph

3349 Commits (02e98810a9fa895b8215e864f11e537cbd125bae)

Author SHA1 Message Date
deosrc cf5f0690f0
Typo fix (#77648) 3 years ago
Brian Coca b439e41a91
expand ansible-doc coverage (#74963)
* Expand ansible-doc to tests/filters and fix existing issues

  enable filter/test docs if in single file or companion yaml
  add docs for several filters/tests plugins
  allow .yml companion for docs for other plugins, must be colocated
  verify plugins are valid (not modules, cannot)
  fix 'per collection' filtering
  limit old style deprecation (_ prefix) to builtin/legacy
  start move to pathlib for saner path handling
  moved some funcitons, kept backwards compat shims with deprecation notice

  Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
  Co-authored-by: Felix Fontein <felix@fontein.de>
  Co-authored-by: Sandra McCann <samccann@redhat.com>
3 years ago
Sandra McCann a65fbfad5b
trim down to use sanity test docs requirements file (#77612)
* trim down to use sanity test docs requirements file
* add requirements back
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update docs/docsite/rst/community/documentation_contributions.rst
3 years ago
David Moreau Simard 709ae7c050
docs: Update porting guide for ansible 5.7.0 (#77646) 3 years ago
Felix Fontein 841bdb74eb
Replace antsibull with antsibull-docs (#77504) 3 years ago
Sandra McCann 096393a221
add select distro installs to docs (#77567) 3 years ago
Andrew Klychkov 3cbfee7852
community_steering_committee.rst: add new member (#77589) 3 years ago
Sandra McCann 3b0d74c145
Add contributor path page (#77494)
Co-authored-by: Emmanuel Ugwu <32464178+ugwutotheeshoes@users.noreply.github.com>
3 years ago
Kajsa Gauza 0c1cb0e9d4
Fix a broken link and some grammatical errors (#77531) 3 years ago
Matt Martz 789d29e895
Update docs to recommend the TTY for prompts over stderr (#77533) 3 years ago
Brian Coca 2fc73a9dc3
update python devel docs (#77499)
* update python devel docs

Co-authored-by: Sandra McCann <samccann@redhat.com>
3 years ago
Martin Krizek cbe42bff7f
Allow for lazy evaluation of Jinja2 expressions (#56116) 3 years ago
Will Thames c3a3bc1d0d
Allow strftime to display time in UTC (#70351) 3 years ago
Andrew Klychkov 553a226da5
Steering Committee: add new member (#77529) 3 years ago
David Moreau Simard 0d9a580f24
docs: Add porting guide for Ansible 6.0.0a1 (#77526) 3 years ago
Iheanacho Amarachi Sharon fa7c5d9b10
Update reporting_bugs_and_features.rst (#77518) 3 years ago
Matt Martz 727387ad76
2.14 Roadmap (#77387)
Co-authored-by: Matt Clay <matt@mystile.com>
3 years ago
Emmanuel Ugwu 538a19b748
Update developing_collections_structure.rst (#77496) 3 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
3 years ago
Martin Krizek 7126bfc61c
Clarifying how handlers are handled (#77372) 3 years ago
Brian Coca d7d2afd203
avoid recursion in example (#77436) 3 years ago
Travis Michette 6da4186f6e
Update installing_collections_file.rst (#77439) 3 years ago
Sandra McCann e8dbc84afe
Trivial (#77467)
Co-authored-by: Iheanacho Amarachi Sharon  <58210919+Iheanacho-ai@users.noreply.github.com>
3 years ago
David Moreau Simard 36371500b7
docs: Update porting guide for ansible 5.6.0 (#77466) 3 years ago
Sandra McCann 26631de88c
Document how to release a collection (#77391)
Co-authored-by: Divine Odazie <dodazie@gmail.com>
3 years ago
Andrew Klychkov 82c622a26a
community_steering_committee.rst: add chairperson (#77454) 3 years ago
Dr. András Korn ac56647f4a
INI: values with spaces can be single or double quoted (#77369) 3 years ago
Alicia Cozine 21addac5da
Docs cheatsheet - skeleton and ansible-playbook (#76655) 3 years ago
bluikko 6557a60d08
Most Matrix channels are ansible.com and not .im (#77352) 3 years ago
Christian Adamini e918cfa588
Fix list formatting (#77354) 3 years ago
rwhector bf8e186c68
Example is a single play, not a playbook 3 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
3 years ago
Martin Krizek 6d260ad967
Remove COMMAND_WARNINGS and warn (#77411)
* Remove COMMAND_WARNINGS and warn

Fixes #77394
3 years ago
Matt Clay 50d4cf931c
Start of 2.14 development cycle. (#77378)
* Delete old changelog fragments.
* Add 2.14 changelog stub.
* Add porting guide.
* Update version and codename.
* Add temporary deprecated version ignores.
3 years ago
Felix Fontein 7075fa36a1
Bump requirements for antsibull to 0.42.0 (which depends on antsibull-changelog >= 0.14.0). (#77362) 3 years ago
Matt Clay 3e491db466
Porting guide fixes. (#77376)
* Update porting guide generation.
* Fix 2.13 porting guide link.
3 years ago
Sandra McCann f03624e295
clarify how to customize ansible cli output (#77357) 3 years ago
Sandra McCann 2e69b5867e
Creat steering committee docs (#77330)
Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>
3 years ago
bluikko 27aa2612d9
Add what to look for in PyYAML documentation (#77323)
Co-authored-by: Martin Krizek <martin.krizek@gmail.com>
3 years ago
Christian Adamini fa12af9042
Revision: "Address Docs: How to report bugs" #53520 (#77269) 3 years ago
bluikko ffda8ccbbd
Incorrect parent role paths var description (#77342) 3 years ago
David Auer 0a5b2e88f3
Fix quotes (#77346) 3 years ago
Sloane Hertel f96a661ada
ansible-galaxy - add configuration options for more flexible collection signature verification (#77026)
* Add a toggle to control the number of signatures required to verify the authenticity of a collection

* Make the default number of required valid signatures 1

* Add option to make signature verification strict and fail if there are no valid signatures (e.g. "+1")

* Use a regex to validate --required-valid-signature-count

* Add a toggle to limit the gpg status codes that are considered a failure

* Update documentation and changelog

* Add unit and integration tests for the new options

* Fixes #77146

Fix using user-provided signatures when running 'ansible-galaxy collection verify ns.coll --offline'

Add a test for a user-provided signature when running ansible-galaxy collection verify with --offline

Fix displaying overall gpg failure without extra verbosity

Add a test for displaying gpg failure without verbosity

Improve documentation to be more clear that signature verification only currently applies to collections directly sourced from Galaxy servers
3 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>
3 years ago
Matt Martz 82e5f368e1
Reduce intro install to just pip (#77178) 3 years ago
Stef B 8a86fa602d
Simplify documentation for search paths (#73818) 3 years ago
Tommaso Macchioni 14098d9b04
typo variable reference (#77327) 3 years ago
Ganesh Nalawade 68b5db328f
Update ansible extension information (#77235)
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
ee-github c555ce1bd9
Update intro_patterns.rst (#77300)
Describe difference between targeting a single host using -i vs. --limit.  In particular, pointing out the behavior difference that -i will not rad inventory variables.
3 years ago
David Moreau Simard d8687bd015
docs: Update porting guide for Ansible 5.5.0 (#77287) 3 years ago
Sandra McCann dfda04894f
stub out ipaddr page and point to new home (#77281) 3 years ago
Christian Adamini 6546c484f4
Address Docs: How to report bugs #53520 (#77214) 3 years ago
Jasmine Hegman 1a923e307e
After 2.10 Collections can use vars plugins (#77216) 3 years ago
Jasmine Hegman b60a5eefb2
Include links to the modern homes of the windows modules (#77220) 3 years ago
Ganesh B. Nalawade 3c72aa32d6 Add ansible devtools working group in community communication 3 years ago
lumean 1ba3ead0a0
Update developing_modules_general_aci.rst (#73925) 3 years ago
Matt Clay 3d5637beec Initial mypy sanity test support for core. 3 years ago
Divine Odazie 50d28de9ba
Make ansible_index.rst more readable (#77225) 3 years ago
Sandra McCann 7d234a40ee
Point to AH docs (#77200) 3 years ago
Matt Martz 7b0fb114be
Data tagging and sidecar docs are delayed, and will be retargeted for 2.14 (#77173) 3 years ago
Sandra McCann 8291dbdf81
add accessibility guidelines to docs style guide (#77145)
Co-authored-by: Jill R <4121322+jillr@users.noreply.github.com>
3 years ago
Martin Nečas 0d4219f265
Fix IPs for ipaddr filter in user_guide (#77151)
* Fix IPs for ipaddr filter in user_guide

* Apply suggestions from code review

Co-authored-by: Sandra McCann <samccann@redhat.com>
3 years ago
Sloane Hertel c3999d89f4
Clarify docs for using tests as filters (#77155) 3 years ago
Andrew Klychkov 68601601ce
Docsite: update communication.rst (#77135)
\
3 years ago
Sandra McCann 22ba18d7b0
add links to remote_user docs (#77140)
* add links to remote_user docs
* shorten link name
3 years ago
Sandra McCann 6a7009a84f
use present tense in changelog example (#77138) 3 years ago
Sandra McCann 5f258d2c64
move collection pr quickstart over (#77087)
* move collection pr quickstart over
* add link
* fix CI
* fix formatting
3 years ago
Aine Riordan 71dfe32ab6
76134 DOCS:Uninstall all packages before Ubuntu reinstall (#77137) 3 years ago
Matt Clay 3f0d5bc351 Fix LooseVersion and StrictVersion refs in docs. 3 years ago
Sandra McCann 30d1a93d93
update changelog fragment guidance with examples (#77040)
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
3 years ago
David Moreau Simard 36121aeee7
docs: Update porting guide for ansible 5.4.0 (#77107) 3 years ago
Matt Clay 0f41682473 Remove use of distutils in docs Makefile.
The current usage only works if `python` is Python 2.x since the syntax is invalid on Python 3.x.

When running on Python 3.x it would either be missing, or if Python 2.x was also present, incorrect.
3 years ago
Sandra McCann b2bafc054e
remove list of container images (#77089)
* remove list of container images
* remove some more centos8
3 years ago
Sandra McCann 901e3d43b1
describe how to generate a sample ansible.cfg (#77053)
* describe how to generate a sample ansible.cfg
* correct commands used
3 years ago
Brian Coca 84b85a5b5a
more explicit moustache docs (#77051) 3 years ago
Sandra McCann e620b96f49
Create collection maintainer's guide (#76976)
* initial merge of maintainer guide
* Apply suggestions from code review

Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>

Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>
3 years ago
Sandra McCann af7c9deb4e
add crosslinks for changelog fragments (#77022) 3 years ago
fbourqui 1480503326
Update complex_data_manipulation example uptime in days/h/m/s (#77019) 3 years ago
Preston Carman f82b1ba67c
Update indentation for example in playbooks_handlers.rst (#75348) 3 years ago
Sandra McCann 32f7490a2c
Add note to serial docs (#77006)
* add note to serial docs
* add keyword directly
Fixes #76820
(cherry picked from commit de20f1bae8)
3 years ago
zasca 8939f4d2f7
add tasks (#75489) 3 years ago
Sloane Hertel 43e55db208
ansible-galaxy - add signature verification of the MANIFEST.json (#76681)
* ansible-galaxy collection install|verify:

  - Support verifying the origin of the MANIFEST.json when the Galaxy server has provided signatures.
  - Allow supplemental signatures to use during verification on the CLI/requirements file.

* ansible-galaxy collection install:

  - Support disabling signature verification. This silences the warning provided by ansible-galaxy if the Galaxy server provided signatures it cannot use because no keyring is configured.
  - Store Galaxy server metadata alongside installed collections for provenance. This is used by 'ansible-galaxy collection verify --offline'.

* Add unit tests for method that gets signatures from a Galaxy server

* Add integration tests for user-provided signature sources

- Test CLI option combinations
- Test installing collections with valid/invalid signature sources
- Test disabling GPG verification when installing collections
- Test verifying collections with valid/invalid signature sources

* Make signature verification advisory-by-default if signatures are provided by the Galaxy server

- Make the default keyring None
- Warn if the keyring is None but the Galaxy server provided signatures
- Error if the keyring is None but the user supplied signatures
- Error if the keyring is not None but is invalid

* changelog

* add ansible-galaxy user documentation for new options

Co-authored-by: Matt Martz <matt@sivel.net>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Martin Krizek <martin.krizek@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Andy Mott <amott@redhat.com>
Co-authored-by: John R Barker <john@johnrbarker.com>
3 years ago
IronTooch 65987e86a9
Added package reference for Debian to resolve error (#76876) 3 years ago
Vladimir Botka 5448661aec
Update 'Ansible and BSD' section 'Setting the Python interpreter'. (#76825) 3 years ago
Abhijeet Kasurde a1af1d94cd
vmware: Migrate VMware Scenario Guides (#76640)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
ChunPanYung 0ca19a5b73
Update windows_winrm.rst (#76835)
Co-authored-by: Jordan Borean <jborean93@gmail.com>
3 years ago
Vladimir Botka 9a9ef01997
Update 'Installing Ansible on FreeBSD'. (#76849)
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
3 years ago
Matt Martz 3108c51764
Add note about installing python on macOS (#76873) 3 years ago
Daniel Goldman e1cf6af06d
add `undef()` keyword to core 2.12 porting guide (#76880) 3 years ago
David Moreau Simard 10fd7bf12c
docs: update porting guide for Ansible 5.3.0 (#76917) 3 years ago
Felix Fontein 1f4e50f178
Ansible 6 roadmap: simplify collection inclusion process (#76932)
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
3 years ago
Matt Clay 2767a4cf4a
docs - remove broken link in ACI scenario guide (#76940) 3 years ago
Felix Fontein bc1e29d722
Bump antsibull version from 0.40.1 to 0.41.0 and ansible sphinx theme version to fix HTML generation in return value tables (#76759)
* Use Jinja2 comment instead of HTML comment to avoid W3C validator warning (-- inside comment).

(For those interested in the history of this: http://www.howtocreate.co.uk/SGMLComments.html#doubledash)
3 years ago
Stephen Lawrence 2bd074b486
doc: fix Jinja2 doc link templating playbook (#76889)
Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
3 years ago
Joe Zollo bc5672d9ba
Update developing_modules_general_windows.rst (#76846) 3 years ago
Sandra McCann a5283d67ee
add quoted examples (#76858) 3 years ago
Felix Fontein ebea751805
Roadmap for Ansible 6 (#76772)
Co-authored-by: John R Barker <john@johnrbarker.com
3 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
3 years ago
Syed Ali Haider 6bca0a5dc2
docs: add fqcn to module examples (#73546)
Co-authored-by: Felix Fontein <felix@fontein.de>
3 years ago
Tong He ddc4b1716b
Mention ansible-core 2.11 RPM package in Ansible Core Installation Guide (#76801) 3 years ago
Sandra McCann 61bd779335
add core roadmaps to ansible docs (#76818)
* add core roadmaps to ansible docs
* make older roadmaps also show up
3 years ago
Sandra McCann 5a69023941
remove ansibot from collection docs (#76817)
* remove ansibot from collection docs
* Update docs/docsite/rst/community/collection_development_process.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
3 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
3 years ago
David Moreau Simard e33e7233d0
docs: Update porting guide for ansible 5.2.0 (#76746) 3 years ago
Sandra McCann 665e3dc629
remove outdated note on limitations of R() in module docs (#76736) 3 years ago
Mario Lenz 01ba6d4a45
Fix C&P error (#76673) 3 years ago
Felix Fontein c53e6d94e9
Use antsibull 0.40.1 for docsite build (#76675) 3 years ago
Or Bin a1d0e60703
Fixed documentation: "[a] ini file" -> "an ini file" (#76627) 3 years ago
darran-c fdf12542b2
Fix typo in task name (#76642) 3 years ago
Or Bin aa4f23dc97
Fixed documentation: "do not needed -> do not need" (#76617) 3 years ago
David Moreau Simard e2d1dbbdc5
Docs: update porting guide for ansible 5.1.0 (#76595) 3 years ago
Alicia Cozine 67e5649a26
Adds documentation about when/why to use roles (#76560)
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
3 years ago
Jordan Borean 4c738b08b4
Add docs on Windows module util requirements (#76583) 3 years ago
Matt Martz 8a4090f749
Do not format the choice as a definition list for non-mapping values (#76568) 3 years ago
Jordan Borean 7dd22b8b4b
Update Windows host requirements (#76582) 3 years ago
Simon Monai 5db1d11c19
Replace "Encrypt" with "Hash" for prompt documentation (#76584)
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
3 years ago
Jon "The Nice Guy" Spriggs 47e2a26959
Update playbook_tests with type testing (#72732) 3 years ago
Abhijeet Kasurde 601d66c7e5
k8s: Migrated scenario guides to collection (#75249)
Kubernetes scenario guides are moved to
``kubernetes.core`` collection.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Jacob McGill ee777567bc
Update intro_inventory.rst (#76340) 3 years ago
Kian Meng, Ang e5967c02f5
Fix typos in docs (#76526) 3 years ago
David Moreau Simard 6ee58056da
docs: Update porting guide for ansible 4.10.0 (#76559) 3 years ago
Sloane Hertel 146a4bcd0d
Fix docs for installing from a git repo (#76350) 3 years ago
Dan Kolepp 9dac51f25a
Update special_variables.rst (#76360) 3 years ago
Benoît Geeraerts 8a562ea14a
Resolves #76449 Misplaced added version info (#76539)
`.. versionadded::` are coming right after the section tittle, and was misplaced here
3 years ago
Edward Hilgendorf d0de3d3dc2
change keyword return to results (#76515)
value is getting associated to python keyword return
3 years ago
Sandra McCann 0cec4d1cfc
remove aws from the azure note (#76518) 3 years ago
Sandra McCann 0df60f3b61
per marketing request - add note for AAP on Azure availability (#76512) 3 years ago
Sandra McCann bccfb83e00
add intersphinx mapping for Ansible 5 (#76470)
* add intersphinx mapping for Ansible 5

* add the other files
3 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
3 years ago
Martin Krizek 3fe42e106c
Remove finalize from globals (#76439) 3 years ago
Sviatoslav Sydorenko 82ff7efa94
Fix how/what+look/like grammar in dev process doc (#76410) 3 years ago
Sloane Hertel 5b2334983c
Fix more 'playbook'/'play' conflation (#76387) 3 years ago
David Moreau Simard bf1e1d286d
docs: Update porting guide for Ansible 5.0.1 (#76444) 3 years ago
David Moreau Simard 1d1597ffd9
Docs: Update porting guide for Ansible 5.0.0 (#76404) 3 years ago
Sandra McCann 862a2a3599
set latest Ansible version to 5 (#76304) 3 years ago
Sandra McCann a1205d52ce
update release and maintenance for Ansible 5 (#76301) 3 years ago
David Moreau Simard b9b69c1135
Docs: Update porting guide for ansible 4.9.0 (#76363) 3 years ago
David Moreau Simard 0afc0b8506
Add a link to the Ansible 5.x changelog (#76352)
The 5.x changelog is available, add a link to it.
3 years ago
nemobis 0360728b7f
Fix typo in docs for "globbing" (#76324)
Constent with the rest of the documentation including fileglob.
3 years ago
Sandra McCann c379e61b8b
Update docs build requirements to most recent versions of dependencies (#76283)
* align requirements files to more recent versions

* bump up to latest antsibull

* update sphinx in rstcheck requirements

* update to dependency versions that sphinx 4.2 pulls in

* use same no-cap spelling
3 years ago
Matt Martz 04698b0c41
Add porting guide entry for fetch_url change in behavior (#76314) 3 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.
3 years ago
David Moreau Simard d0ec236d4a
Update porting guide for Ansible 5.0.0b2 (#76303) 3 years ago
azrdev fd4460c1e4
docs/best_practices: all contained vault passwords required when using inventory (#75976) 3 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>
3 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>
3 years ago
Aine Riordan 90de24da7b
Docs: Link to valid data types for role parameters (#76276) 3 years ago
Daniel Goldman be2bd2f1af
Documentation for other types in collection `requirements.yml` (#75872) 3 years ago
David Moreau Simard 55dc75b8c8
Update porting guide for Ansible 5.0.0b1 (#76263) 3 years ago
Sandra McCann 22eb4a9ce0
Remove edit on github from collection pages (#76259)
* remove main index page from Edit on Github
* remove all collection index pages from Edit on Github
3 years ago