Commit graph

119 commits

Author SHA1 Message Date
Willams de Lima
fa05af8321
Fixing ad-hoc commands () 2021-02-18 16:48:22 -06:00
Brian Coca
dec443e3a5
why no mfa? ()
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Rick Elrod <rick@elrod.me>
2021-01-22 14:58:35 -05:00
Koki Kato
d500e6ec45
doc: fix ansible_play_hosts description about failure ()
The variable ansible_play_hosts actually does _not_ includes failed or unreachable hosts.

+label: docsite_pr
2021-01-18 15:24:29 -05:00
Simon Heimberg
ad4ddd8211
document what the name of a play is ()
##### SUMMARY

Make clear that `ansible_play_name` is the name attribute from the play and not the file name of the playbook.

improves 

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-11-17 11:56:49 -05:00
Zois Pagoulatos
eee13962e5
Minor typo in test_strategies.rst () 2020-10-01 14:34:23 -04:00
Andrius Benokraitis
c5a161b2b0
Update faq.rst ()
Added link to https://access.redhat.com/solutions/5295121 in third sentence
2020-09-28 11:07:03 -04:00
Brian Coca
9a39452a31
update the definition of changed ()
* add nuance to the definition of changed, add notes to modules that return "changed" without changing state
2020-09-24 14:33:22 -05:00
Sandra McCann
70e25dc158
clarify releases download for older releases only () 2020-09-24 09:57:16 -05:00
Sandra McCann
4aedd1b987
add new glossary terms for 2.10 ()
* add new terms for 2.10
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-09-24 09:45:54 -05:00
Alicia Cozine
b430f9b9aa
Adds FAQ and other pointers for collections () 2020-09-09 13:16:26 -04:00
esmersmith
a34043c6be
Changed all_modules references to list_of_collections in the documentation () 2020-09-09 11:43:40 -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
Sandra McCann
553ccedcd3
Update release page for ansible and ansible-base ()
* [docs] 2.7 is EOL, add 2.10 which is almost out
- Remove 2.7 support from the maintenance schedule
- Add 2.10 which is in RC and will be out soon enough.
Signed-off-by: Rick Elrod <rick@elrod.me>

* Update docs/docsite/rst/reference_appendices/release_and_maintenance.rst, fix table and separate ansible-base from ansible, fix rstcheck errors, clean up sections, explain the two packages
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Rick Elrod <rick@elrod.me>
2020-08-12 15:51:38 -05:00
Håkon Solbjørg
e72e12aa27
docs: 'ansible_play_hosts' lists active hosts, not limited by serial ()
ansible_play_batch lists the currently targeted host(s) in the serial/batch, while
ansible_play_hosts lists all the hosts which will be targeted by the play.
2020-08-10 09:42:45 -05:00
Brian Coca
11a31e99e6
added note about fakeroot ()
see 
2020-08-03 16:36:26 -04:00
Terciero
864573a38d
Document common return values with examples ()
* adding return value examples
* shift to console code blocks
* cleaning up whitespace and shortening invocation example
* reordering diff section
2020-08-03 11:51:58 -05:00
Rick Elrod
14dc4de424
Update docs for --tags default, and add some tests ()
Change:
- Clarify that not passing `--tags` will cause `ansible_run_tags` to
  default to `["all"]`.
- Add some extra coverage around `ansible_run_tags`

Test Plan:
- New integration and unit tests

Tickets:
- Fixes 

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-07-29 17:16:57 -05:00
Baptiste Mille-Mathias
59513ae673
Fix incorrect statement to set a variable for a playbook ()
Fixes 
2020-07-20 13:45:40 -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
Alicia Cozine
db354c0300
Docs: User guide overhaul, part 5 () 2020-07-14 17:00:44 -04:00
Alicia Cozine
6fffb0607b WIP: Docs: User guide overhaul, part 4 ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-05-15 16:18:07 -04:00
Matt Martz
087be1da50
Allow tasks to notify a fqcn handler name ()
* Allow tasks to notify a fqcn handler name

* Add tests. Fixes 

* Add changelog fragment

* Add test to ensure handlers are deduped properly with fqcn, role, and just handler names

* Add some docs about new special vars
2020-04-08 11:36:38 -05:00
Sandra McCann
8042d226e4
fix make webdocs warnings () 2020-03-25 13:13:56 -05:00
Fedor V
967e05bb23
DOC fix: typo in group addressing syntax () 2020-03-24 09:03:08 +01:00
dirkvbok
4083514d3e
Fix typo and styling FAQ docs () 2020-03-24 09:00:03 +01:00
Andrew Klychkov
ad8df69b58
docs/docsite/rst/: fix typos () 2020-02-21 10:57:07 +00:00
Francisco J. Capdevila
ed4fccb308
Fix typo () 2020-02-14 15:22:58 -05:00
Bas
f35293c052
Update YAMLSyntax.rst with yamllint ()
* Update YAMLSyntax.rst with yamllint

Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-02-14 12:18:13 -05:00
Piotr Stawarski
a0247d13d8
New magic var: ansible_config_file ()
* Add `ansible_config_file` magic variable

* Add ansible_config_file to INTERNAL_VARS

* Add changelog fragment

* Update Special Variables docs
2020-02-11 15:49:55 -05:00
yiskylee
1f0b5b09cd Explanation for "check_mode: no" is confusing ()
When an ansible module, e.g., command, does not support check mode, you can use "check_mode: no" in that task to execute the task in normal mode, even when "--check" flag is used. The current document basically says, use "check_mode: no" to run in check mode, which is confusing and inaccurate.
2019-12-12 17:04:57 -06:00
Sandra McCann
af64e9ce6a add Automation Hub stub page ()
* add Automation Hub stub page

* implement feedback
2019-11-25 13:58:01 -06:00
Felix Fontein
b6f0f14dd3 Document diff. () 2019-11-19 09:46:59 -05:00
SriVignessh Pss
161e0be89b Fix access variable name programmatically faq docs ()
* Add an example of replacing dashes with underscores in interface names for IPv4
2019-11-14 15:38:40 -06:00
Kiyo Nagamine
84bffff96a Fixed tiny typo in interpreter_discovery.rst ()
Added missing '/'
2019-11-08 22:47:16 +05:30
Ashley Hardin
78be0dcbc8 Update faq.rst () 2019-11-05 16:55:01 -05:00
aaronk1
0e4716d326 Clarify Python 2.x support in python_3_support.rst ()
+label: docsite_pr
2019-11-05 16:08:07 -05:00
Sandra McCann
3f808d9ed6 [Doc-Release-2.9] update release and maintenance page for 2.9 ()
* update release and maintenance page for 2.9
* only 2.4 and earlier used the old changelog system
2019-10-31 20:20:34 -05:00
Sandra McCann
ae265bc546 Move galaxy appendix info to a new Galaxy section ()
* start galaxy docs restructure
* shared snippets in txt files
* moved all content to galaxy section
2019-10-11 13:19:44 -05:00
Alicia Cozine
941a9b68fc Docs: User guide overhaul, part 1 () 2019-10-08 13:46:38 -04:00
Andreas Olsson
c8315bfd60 Prefer https:// links in the docs site ()
This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.
2019-09-30 15:11:19 -04:00
Michael Prokop
b33ae14949 doc: fix typos () 2019-09-26 10:18:29 -04:00
Jordan Borean
2fbe4ca102 Fix galaxy server reference in the docs () 2019-09-05 10:47:19 -04:00
Alicia Cozine
6ad40fd6b8 removes the word 'support' from appendix pages () 2019-08-27 17:11:53 -04:00
Steven B
05c586e3ef List supported platforms for RH customers ()
*  List supported platforms for RH customers
2019-07-30 09:09:42 -04:00
Martin Krizek
aea5b795c0 Make ansible_index_var accessible as a magic var () 2019-07-12 08:50:19 -04:00
Brian Coca
c2469648e4 Docs on general precedence ()
* Add docs/docsite/rst/reference_appendices/general_precedence.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-07-09 12:14:40 -05:00
Alicia Cozine
44b6f2ff56 removes last :doc: links in other sections of the docs ()
* removes last :doc: links in other sections of the docs

* fix references to playbooks intro page
2019-06-27 12:18:17 -04:00
Arnaud RENARD
1a5fd720a4 Ansible galaxy role download should not have to perform aditionnal check against tar archive file extension . ()
Ansible galaxy role download checked for `.tar.gz`, but `tarfile.is_tarfile(...)` can identify and open any valid tarfile. This change uses transparent stream compression to make `.tar.gz` and `.tar.bz2` formats valid with python 2.6.x/2.7.x (as well as `.tar.xz` with python 3.x).
2019-06-13 09:23:41 -05:00
Bill Nottingham
c493593b4b Adjust assorted terminology and wording around product offerings. ()
* Adjust assorted terminology and wording around product offerings.

* Update docs/docsite/rst/dev_guide/style_guide/trademarks.rst
* Update docs/docsite/rst/user_guide/modules_support.rst
* Update docs/docsite/rst/reference_appendices/tower.rst
2019-05-31 14:24:44 -05:00
Sandra McCann
f097dca60d update release table for 2.8 () 2019-05-15 14:58:53 -05:00