Commit graph

65 commits

Author SHA1 Message Date
Kenyon Ralph
d3f2f600c7 common_return_values.rst: add missing closing parenthesis (#54487) 2019-03-27 23:00:21 +01:00
Matt Martz
6996926d89
Expose loop_control.loop_var as ansible_loop_var (#54240)
* Expose the loop_var as ansible_loop_var

* Add docs

* fix assert test

* Indicate version added
2019-03-26 11:07:54 -05:00
Matt Davis
4d3a6123d5
Python interpreter discovery (#50163)
* Python interpreter discovery

* No longer blindly default to only `/usr/bin/python`
* `ansible_python_interpreter` defaults to `auto_legacy`, which will discover the platform Python interpreter on some platforms (but still favor `/usr/bin/python` if present for backward compatibility). Use `auto` to always use the discovered interpreter, append `_silent` to either value to suppress warnings.
* includes new doc utility method `get_versioned_doclink` to generate a major.minor versioned doclink against docs.ansible.com (or some other config-overridden URL)

* docs revisions for python interpreter discovery

(cherry picked from commit 5b53c0012ab7212304c28fdd24cb33fd8ff755c2)

* verify output on some distros, cleanup
2019-02-27 23:52:02 -08:00
Tobias Vollmer
c5a1ec4692 ansible-galaxy init does create a sub directory (#52390)
`ansible-galaxy init` creates a directory named `role_name` (in the given example) instead of adding the structure in the current working directory.

Additionally adding a clarification for repository creation as the proper repository root is not described yet.

+label: docsite_pr
2019-02-18 15:07:30 -05:00
Sayed Anisul Hoque
bf20c4126c Updated the ansible-galaxy docs (#52070)
* Updated the ansible-galaxy docs

<!--- Your description here -->

Updated the documentation that reflects the default branch that will be used for the `version` option in ansible-galaxy.

+label: docsite_pr

* Updated the documentation

As per the code (6d4307377f/lib/ansible/galaxy/role.py (L237))[ansible/galaxy/role.py] Defaults to the branch set as a default in the repository otherwise defaults to the master.

* Update docs/docsite/rst/reference_appendices/galaxy.rst

Co-Authored-By: anis016 <anis016@users.noreply.github.com>
2019-02-12 16:33:54 -05:00
vvvlc
48442a4a33 added pipelining for z/OS (#51212)
* added pipelining for z/OS

* Update docs/docsite/rst/reference_appendices/faq.rst

agreeed

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

agreeed

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update docs/docsite/rst/reference_appendices/faq.rst

* Update docs/docsite/rst/reference_appendices/faq.rst

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: vvvlc <vitezslav+github@vvvlcek.info>

* Update faq.rst

reformatted section for error message `The module libpython2.7.so was not found.`
2019-01-25 10:42:54 -05:00
Felix Fontein
f6122fb63b Fix docs syntax highlighting errors (#50836)
* Add support for [WARNING]: ...

* Fix unreachable/failed output lexing.

* Detecting retry/--limit lines.

* Removing strange (invisible) characters which cause lexing problems.

* Using better-fitting lexers.

* Improve YAML lexing: don't accept quotes in keys.

* Add Django lexer (unchanged) from Pygments.

* Add support for != and % operators.
2019-01-24 16:09:41 -06:00
Sandra McCann
16511501b6 Remove outdated minor release info from table (#50903)
* removed outdated minor release info from table
* fixed grammar nits
* added link to releases
2019-01-23 15:22:40 -06:00
Simon Legner
33b9c880a4 Consistent typesetting of "GitHub" (#50929) 2019-01-15 14:53:04 +01:00
Jonas DOREL
d9ae906772 Add galaxy.html#dependencies link (#49984)
* Add galaxy.html#dependencies link

+label: docsite_pr
2019-01-03 12:06:10 -05:00
Aaron Surty
81a6007307 ansible-doc: update faq to include common z/OS pitfalls (#18555) (#49504)
* ansible-doc: update faq to include common z/OS pitfalls (#18555)
Co-Authored-By: gitaaron <aaron.surty@gmail.com>
2018-12-21 13:50:30 -06:00
plastikat
4b300189fd Fix docs typo at Special Variables (#50230) 2018-12-21 11:11:54 +05:30
Abhijeet Kasurde
eb61d26a2a Add missing parameter in virtualenv command (#49675)
Fixes: #43115

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-12-10 16:43:33 -06:00
Andreas Krüger
18bf48cec2 Pull documentation of ansible.module_utils.basic from (improved) doc strings. (#48416) 2018-12-10 09:17:15 -06:00
Matt Martz
9007dbec2f
Add info about loop based on jinja2 loop var (#42134)
* Add info about loop based on jinja2 loop var

* ansible_loop

* Update test count

* Add extended loop_control that defines whether ansible_loop should be added

* Extended needs to be defaulted

* Revert "Update test count"

This reverts commit f1e93ee469825f4cdcd90fb28667d29aa088275c.

* Add docs about loop_control.extended

* Add revindex and revindex0

* Document ansible_loop in special vars

* Add changelog fragment

* Add tests, change items to allitems so that dot notation works, fix logic error with previtem
2018-12-07 13:49:50 -06:00
owenmann
23637aa349 Update faq.rst: typo (#49491)
* Update faq.rst

<!--- Your description here -->
minor: typo

+label: docsite_pr
2018-12-04 15:44:29 -05:00
Alex Ratner
0c7f6e5047 fixes for typos, grammar, and links (#48721)
* fixes for typos, grammar, and links on magic vars page
2018-11-15 17:46:41 -06:00
Xaroth
87d10b9b78 Include dependency role names in role_names. (#46483)
* -Change: Include dependency role names in `role_names`.
-Add: `play_role_names` magic variable to include only explicitly named roles (formerly `role_names`).
-Add: `dependent_role_names` magic variable to include all dependency names for all roles.

* -Change: use the ansible_ prefix for new magic variables.
-Change: keep `role_names` as a deprecated variable, using the old functionality.

* -Add: changelog fragment for the role_names rework.

* -Add: Tests for the role_names (and ansible_*role_names) special variables

* -Fix: resolve erroneous documentation snippet that was introduced after rebasing.

* -Fix: explicitly sort to ensure list comparison works in test.
2018-11-15 10:01:29 -05:00
Adam Miller
2b1ca25e59 docs - adapted abadger's changelog announcement email into dev process (#48172)
* docs - adapted abadger's changelog announcement email into dev process

Signed-off-by: Adam Miller <admiller@redhat.com>

* migrate changelog docs to one place, add ref to old location

Signed-off-by: Adam Miller <admiller@redhat.com>

* add changes based on feedback

Signed-off-by: Adam Miller <admiller@redhat.com>

* Refines changelog docs, minor re-org of page

* moves links and anchors for new content

* Further reorg of page

* fixes header per jamescassell
2018-11-13 22:42:02 +00:00
Martin Krizek
1465f70eb5 Add ansible_play_name magic var (#48562) 2018-11-12 11:18:49 -05:00
Brian Coca
7ca6af396e added faq entry on ansible_host + delegation (#48438) 2018-11-12 10:26:15 -05:00
Alicia Cozine
d27d956d71 clarifies FAQ answer about env vars (#48432) 2018-11-09 14:31:29 -05:00
Brian Coca
40d8b91d07 added missing vars (#47993)
fixes #31900
2018-11-02 13:38:29 -05:00
Martin Krizek
ec32bda2ef ansible-galaxy docs: fix init of container role (#47853) 2018-10-31 15:38:55 -04:00
d3nisko
6c2e4c1ca8 Update YAMLSyntax.rst (#47491)
* Update YAMLSyntax.rst to correct syntax of a list vs dict.
2018-10-25 16:23:47 -04:00
Aurelio Jargas
e58e43279c Fix markup: inline literal with spaces (#47560)
Fixes rST/Sphinx error on the YAML syntax page of the core docs.
2018-10-24 09:55:25 -05:00
Robert Herhold
850355b314 Update links to module sources (#46553)
The documentation still points to the old links for the [core](https://github.com/ansible/ansible-modules-core/tree/devel) and [extras](https://github.com/ansible/ansible-modules-extras/tree/devel) modules. This PR updates the links to the main ansible repository.

+label: docsite_pr
2018-10-08 14:24:19 -05:00
Alicia Cozine
04b726dc14 Updates release & maintenance version docs for 2.7 2018-10-02 11:27:31 -05:00
Andrii Trykush
90126f37cd Corrected typo
Corrected typo
ansible_serach_path --> ansible_search_path
+label: docsite_pr
2018-09-28 12:41:05 -04:00
Veaceslav Mindru
84a4257774 adding git+ssh uri scheme (#36025)
* incorporates git+ssh into existing example
2018-09-17 17:33:56 -05:00
Pilou
95649dc793 FAQ: fix a typo, add link to 'vars' lookup (#42412)
* FAQ: add link to vars plugin doc

* Typo (s/Techinically/Technically/)
2018-09-12 17:33:07 -04:00
Sam Doran
5d6f844eba Add docs on how to write changelog fragments (#42428)
* Add docs on how to write changelog fragments

* Make recommended changes

* Restore lines and make recommended changes

* Add link to new style changelog

Remove redundant mention of old style changelog
2018-09-11 12:23:22 -04:00
Alicia Cozine
9a76441c02
rewrite of the developer guide, part 1 (#45179)
* rewrite of the developer guide, part 1
2018-09-07 08:57:36 -05:00
Brian Coca
cbd54a4b2c added more reasons to avoid dot notation (#43724) 2018-08-31 09:32:36 -05:00
Christopher Torgalson
2dfff57f57 Extends 'which notation should I use' section in FAQ (#43729)
* Extends 'which notation should I use' section in FAQ
2018-08-30 15:47:39 -05:00
Brian Coca
93f5c10714 vars list (#43171)
* vars list

(cherry picked from commit 463b85cf0bcf7a557b857d1ebd3e8bf1b693fa4c)

* updated as per fb
2018-08-27 14:57:32 -05:00
Matt Davis
6b81c36533
restore task arg splatting (#43798)
* restore task arg splatting

* reverts #41804
* supersedes #41295
* fixes #42192
* after lots of discussion amongst the core team, we decided to preserve this feature, clarify the runtime warnings/docs, and prioritize a path toward fixing the underlying behavior that causes this feature to be insecure (un-namespaced facts).

* update faq text

note that warning is disabled when inject_facts_as_vars is

* wordsmithing FAQ entry
2018-08-14 12:58:00 -07:00
Matt Clay
26a1c534be Fix rst link. 2018-08-13 13:41:37 -07:00
Andreas Olsson
00e5123e4c Update documentation based on 301 permanent redirects (#43675) 2018-08-13 14:54:14 -05:00
Andreas Olsson
1a11cecaef Prefer https:// links in the docs site
All the changed urls are availible by way of https://. Most of them
already redirect.
2018-08-01 08:20:40 -07:00
Jordan Borean
ccb2e9d32f Updated release and maintenance page (#42613) 2018-07-31 09:43:24 -05:00
Jiri Tyr
028f79a86b Adding the Ansible way how to create a password hash 2018-07-11 20:30:26 -04:00
Alexandre Vicenzi
df2e0c7c00 Fix broken links. (#42323) 2018-07-04 18:54:49 -07:00
Alexandre Vicenzi
1dafd92c8e Fix Ansible Galaxy documentation link. (#42316)
More info: https://github.com/ansible/galaxy/issues/830
2018-07-04 09:52:47 -07:00
Brian Coca
d497eba196 several FAQ updates and clarifications 2018-07-02 10:46:59 -04:00
Alicia Cozine
e0a9a71b04 updates docs links to changelogs for all versions (#41289)
* updates docs links to changelogs for all versions

* updates latest 2.5 release
2018-06-28 13:09:22 -07:00
Troy Murray
15ce7c5bab change OS X to macOS (#41294)
* change OS X to macOS

<!--- Your description here -->

+label: docsite_pr

* Update all Mac OS X references to be macOS

* Drop extra Mac
2018-06-26 14:09:23 -04:00
Ted Timmons
3d78dd6677 add a third way to disable cows (#41866)
* add a third way to disable cows

Cows are great, but there's a third way to disable. I'm sure my RST markup can be improved.

* oops, actually in ansible.cfg
2018-06-25 16:53:19 -04:00
Toshio Kuratomi
8841fdd481 Bump versions on release_and_maintenance doc
(cherry picked from commit c8b1b271c6)
2018-06-21 18:01:19 -07:00
Abhijeet Kasurde
01cdc22ac6
Add documentation around package dependencies (#41437)
Documented procedure to handle package dependencies required by
packages which are Ansible dependencies.

Fixes: #30732
Fixes: #16571

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-06-15 20:44:01 +05:30