Commit graph

661 commits

Author SHA1 Message Date
John R Barker
5288ccd1f6 Correct formatting --arguments (#31808)
* Correct formatting

* Use RST :option:

* ansible-pull --vault-password-file

* Streamlined the language a bit in the intro.

* Exclamation point removal!

(cherry picked from commit 1d86205933)
2017-10-26 07:32:33 -07:00
mikedlr
b22a580e66 Mdd module unit test docs (#31373)
* new documentation for unit testing - especially module unit testing

* unit test documentation reformatting and further fixes

* unit test documentation - point to online coverage reports & fix bad spaces

* Small copy edits.

* First pass copy edit / rewrite. More info needed.

* testing documentation - clean up structure, especially code coverage - reduce repetition

* module unit test documentation - improved introduction

* testing documentation - more fixes from and inspired by review from dharmabumstead

* testing documentation - fixes from mattclay + some other minor tweaks

* More copy edits.

* testing documentation - further fixes from review

* Copy edits

* Copy edits

* More copy edits.

(cherry picked from commit fbbffbabde)
2017-10-26 07:32:33 -07:00
Toshio Kuratomi
a5057519dd Update release and maint for new release
(cherry picked from commit cf2c22770a)
2017-10-25 12:53:06 -07:00
Brian Coca
ccd86d5a00 clarified inventory_dir changes for 2.4 (#31484)
* clarified inventory_dir changes for 2.4

added example on how to restore (mostly) old behaviour for add_hosts

fixes #30901
(cherry picked from commit dc69af50dc)
2017-10-09 20:57:14 -07:00
Brian Coca
7f2c611dfc added toggle to control vars plugin behviour
this should allow user to control how they want the playbook dirs inspected
for additional vars, default now reverts to 2.3 behaviour (top).
corrected paths order
minor doc reword

(cherry picked from commit 7d49b27218)
2017-10-09 12:32:03 -04:00
John R Barker
761b00c5b8 Improve and link Network Proxy docs (#31316) (#31368)
* Improve and link Network Proxy docs

It is possible for proxy issues to cause "unable to open shell", so
detail there.

Having the "how-to" in the debug page makes more sense than on the
porting page, so move it.

Fixed a few formatting issues at the same time.

* Edits

* typo

(cherry picked from commit b79d15e67f)
2017-10-05 18:51:28 +01:00
Brian Coca
4fed711c42 made note about cwd not working for hostlist anymore (#31258)
* made note about cwd not working for hostlist anymore

fixes #31041

* Edits

(cherry picked from commit 5085c3b859)
2017-10-04 14:19:26 -04:00
Andreas Olsson
52998cbb15 Remove git:// urls from docsite and from packaging (#30459)
It's almost always preferable to clone by way of https:// rather than
using the bare git:// protocol. Not only does https:// provide
stronger guarantees it also plays nicer with corporate proxies, etc.
(cherry picked from commit ba0b91b51b)
2017-10-03 12:19:07 -07:00
Scott Butler
bbe73e2261 Fixed bad URL formatting. 2017-10-03 12:16:09 -07:00
Scott Butler
6ca6167cc8 Fixed typo in Yum repo path. 2017-10-03 11:42:39 -07:00
Brian Coca
f993e213da added note about inventory_dir new behaviour (#30865)
* added note about inventory_dir new behaviour

(cherry picked from commit cd5cadfe69)
2017-09-27 12:30:59 -04:00
Brian Coca
64737e1446 corrected import_play into to import_playbook (#30853)
* corrected import_play into to import_playbook

fixes #30744

(cherry picked from commit 17f094bb6a)
2017-09-26 17:28:07 -04:00
Matt Martz
f628881750 Update API example for 2.4
(cherry picked from commit d40eff720c)
2017-09-26 14:40:41 -04:00
jborean93
b92452f775 fix for make webdocs
(cherry picked from commit 0e22afef52)
2017-09-20 22:46:50 -04:00
Dylan Silva
da56535ffc Updated release table for docs (#30649) (#30659)
- Updated table to reflect release of 2.4
- Added in 2.5 as current devel
2017-09-20 16:19:48 -07:00
Brian Coca
5fdcbdaaee More porting updates (#30635)
* Update porting_guide_2.4.rst with more docs and some rst fixes

(cherry picked from commit a030472092)
2017-09-20 15:13:01 -04:00
Adrian Likins
6d5f2dccb2 Misc docsite fixes (#30290)
* Fix refs for local_facts and various cli :option:
* Fix dev_guide/testing_pep8 refs
* remove ref to non-existing 'developing_test_pr'
* Fix ref to ansible-vault encrypt_string
* Removed hard-to-localize colloquialism.
* Rename '_ansible-pull' in playbooks_intro.

It was conflicting with rst/ansible-pull.rst. Nothing
seems to reference it.

* Add explicit targets for and update refs

Replace some ':doc:' use with ':ref:'.

Replace some :ref: to section names with explicit targets
(:doc:`Dynamic vs. Static` -> :ref:`dynamic_vs_static` etc)

* The 'YAML+Jinja' syntax lex fails here, so just use yaml

Since the yaml+jinja highlight fails, code wasnt highlighted
at all, but 'yaml' works more or less.

* just use no lexer for the < python2.6 examples

py3 will fail highlighting them, and 'python2' throws
a lexer warning, and nothing actually highlights it, so
just disable.

(cherry picked from commit 9cc63326b1)
2017-09-19 16:18:11 -07:00
Brian Coca
9ae683e9f4 added missing feature info (#30560)
* added missing feature info

(cherry picked from commit 22c8522cbf)
2017-09-19 17:44:08 -04:00
Toshio Kuratomi
3b86554081 Add a code-smell test for smart quotes and remove smart quotes from all files
(cherry picked from commit c82cf791dd)
2017-09-19 13:00:56 -07:00
Scott Butler
bdce5d2fe0 Updated version in index.
(cherry picked from commit 2213f55c4aa5ec874ba92a0fb3f2966b882aac9a)
2017-09-17 17:18:50 -07:00
John R Barker
bbd90e3b29 porting_guide_2.4 stub entries (#30456)
Addtions to porting_guide_2.4

* deprecated notice for win_package return values
* Added vars plugins, config api, inventory plugins.  These were mostly backwards compatible.
  Added notes for users and devs to check out new features once i write the 'feature docs' I'll
  come back and link to them from here
(cherry picked from commit 5a256dd1c0)
2017-09-17 16:57:54 -07:00
James Cammarata
946515af66 Cleaning up use of include: in docs (#30466)
* Cleaning up use of include: in docs

Switching to import_*/include_* instead.

* Update playbooks_best_practices.rst

* Fix rst syntax

(cherry picked from commit 366a9d861f)
2017-09-17 11:27:53 -07:00
John R Barker
6e77a3ac3a Porting Guides 2.4 (#24539)
* Porting Guides for Ansible Versions

Improve the user facing documentation.
Tell people what changes they need to make

* More porting guides

* Link porting guides from TOC

* Link porting guides from CHANGELOG.md

* typo in link

* Review feedback

* Better CHANGELOG links

* Better links

* code blocks

* Minor changes

* Correct links, comment out network section in 2.4

* Typos

* Revert non 2.4 changes

* Add placeholders for other items

* multiple inventory

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* add win_command/win_shell escaping notes

* Added some windows porting info

* Edit for grammar

* Correct links, delete Net Platform Agnostic

* 2.5 link

* Network changes in 2.4

* facts_namespacing was pushed back to 2.5

Due to lack of time we pushed this back to 2.5 so that the facts in the namespace could be shortened.

* Python version

* Remove FIXMEs - move to seperate PR

(cherry picked from commit 785e604c57)
2017-09-16 10:42:45 -07:00
Toshio Kuratomi
ee1134be95 Document boolean default value treatment (#30062)
* Consistency and document treatment of default bool values

* Document that default bool values can be any Ansible recognized bool.
  choose the one that reads better in context
* For fragments used by the copy module, make bool types use type=bool and not choices

* Edit for clarity

(cherry picked from commit 8a2f069468)
2017-09-14 13:27:48 -07:00
Dylan Silva
527380ac91 Fix bugs with modules_support.rst
(cherry picked from commit 88aa0b7645)
2017-09-11 17:33:36 -07:00
Toshio Kuratomi
61315cd3c5 Remove use of unicode_literals as it is an anti-pattern
from __future__ unicode_literals leads to developer confusion as
developers no longer can tell whether a bare literal string is a byte
string or a unicode string.  Explicit marking as u"" or b"" is the way
to solve the same problem in the Ansbile codebase.

(cherry picked from commit ff13d58c14)
2017-09-11 13:34:21 -07:00
John R Barker
c47da38d43 Update docs version string
Hack until https://github.com/ansible/ansible/issues/28553 is fixes
2017-09-11 07:52:35 -07:00
Abhijeet Kasurde
80b41165cb Misc typo corrections
Fix adds correction for typos

* Anisble to Ansible
* Fasle to False

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 8f6626bd8f)
2017-09-09 10:26:30 -07:00
Adrian Likins
51949fdeec generate rst doc pages for command line tools (#27530)
* let generate_man also gen rst pages for cli tools
* make template-file, output-dir, output format cli options for generate_man
* update main Makefile to use generate_man.py for docs (man pages and rst)
* update vault docs that use :option:
* Edits based on
6e34ea6242 and
a3afc78535

* add a optparse 'desc' to lib/ansible/cli/config.py

  The man page needs a short desc for the 'NAME' field
  which it gets from the option parse 'desc' value.

  Fixes building ansible-config man page.

* add trim_docstring from pep257 to generate_man

  use pep258 docstring trim function to fix up any indention
  weirdness inherit to doc strings (ie, lines other than
  first line being indented.

* Add refs to cli command actions

To reference ansible-vaults --vault-id option, use:

:option:`The link text here <ansible-vault --vault-id>`

or:

:option:`--vault-id <ansible-vault --vault-id>`

To reference ansible-vault's 'encrypt' action, use:

:ref:`The link text here <ansible_vault_encrypt>`

or most of the time:

:ref:`ansible-vault encrypt <ansible_vault_encrypt>`
(cherry picked from commit 89c973445c)
2017-09-08 12:16:33 -07:00
Adrian Likins
66a244facc change generated playbooks_keywords.rst to use an rst 'glossary' (#28843)
* Use a rst glossary for playbooks_keywords docs
* Add a 'Task' and 'Tasks' to glossary.
* Update keywords desciptions,
* use :term: rst ref, some quoting
* Make it more obvious that 'retries' and 'until' need to be used in combination.

(cherry picked from commit 52f2edf19d)
2017-09-08 12:15:22 -07:00
Brian Coca
18fdc34ecf clarify import_ docs (#28395)
* clarify import_ docs

* fixed izpellz

* Copy edits.

(cherry picked from commit f4fff54f68)
2017-09-06 21:59:07 -07:00
Brian Coca
647170b040 introducing ALSO YAML inventory (#28596)
* introducing ALSO YAML inventory

* Copy edits

(cherry picked from commit c3550b58ed)
2017-09-06 21:57:24 -07:00
Matt Clay
9ff5ac344f Fix rst syntax issue in docs. 2017-09-06 20:45:56 -07:00
Dylan Silva
78cae22938 updated modules support page with new information (#29071)
* updated modules support page with new information

* Minor wording tweaks.
2017-09-06 17:15:12 -07:00
Sam Doran
02a362e7de Replace rst extension with html in message (#29022) 2017-09-05 16:59:25 -04:00
Eddie Peters
ea74176a28 Fix small typos and extra whitespace in the docs (#24559) 2017-09-05 13:43:11 -07:00
Sam Doran
f0a0b630f6 Properly format inline code. 2017-09-05 11:54:48 -04:00
Ian Wienand
35d02b28c9 Minor syntax error in block versionadded
The syntax for versionadded is to have the string as a second
argument.
2017-09-05 11:54:48 -04:00
Nicklas Laine Overgaard
859b5df1d4 Fix exported SSL_CERT_FILE variable (#28968)
The variable was pointing to a file with a `.cer` extension but the curl command downloads a `.pem` file which makes executions of the bash script fail
2017-09-05 10:29:11 -04:00
Pilou
d67d202227 Fix typo: s/certfied/certified/ (#28951) 2017-09-02 13:46:46 -07:00
Toshio Kuratomi
13b2bedae6 Make python3 testing doc clearer for distro packaging users (#28948)
https://bugzilla.redhat.com/show_bug.cgi?id=1486612
2017-09-01 20:49:01 -07:00
Fran Fitzpatrick
c51f2f835e Adds documentation for all the regex filters (#28944) 2017-09-01 17:12:15 -07:00
Matt Davis
59787a3dbc minor fixes to docsite root URLs (#28945)
* fix hardcoded http schemes to use relative URLs
* add doc fragment to version selector link to scroll target directly to the selector
2017-09-01 16:48:53 -07:00
Scott Butler
a9f82f8a8a Fixed incorrect version numbers. 2017-09-01 15:42:02 -07:00
Scott Butler
c479d37777 Changed header to say 'devel' instead of 2.4 2017-09-01 15:37:07 -07:00
Lars Kellogg-Stedman
7093622571 docs: add fact caching directives to intro_configuration (#27040)
the fact_caching* configuration directives were not listed in
intro_configuration.rst.
2017-09-01 14:57:58 -07:00
Ron V
8999b98a09 Update playbooks_best_practices.rst (#26714)
fix point of confusion for newer users
2017-09-01 14:56:51 -07:00
Sam Doran
cc7e38890c Clarify how tag inheritance works (#28942)
Fixes #20119

Another crack at PR #27147
2017-09-01 14:55:51 -07:00
Adrian Likins
596dc8c442 Add ANSIBLE_CONFIG envvar to config/envvars tmpl (#28886) 2017-09-01 14:53:42 -07:00
Adrian Likins
933298505a Update places we mention env vars to use :envvar: (#28887) 2017-09-01 14:52:18 -07:00