Commit Graph

400 Commits (075ead8fb0fe26f502f592bcf78851d0e24ac3a4)

Author SHA1 Message Date
Cheng Lian 4c229e566e Fix minor formatting issue in python_3_support.rst (#29161)
Thanks @liancheng!
7 years ago
Luke Short 897f86561f document the required variables for using Windows certificates (#29112)
* document the required variables for using certificates when authenticating to Windows

* clarify that certificates are for local (non-domain) users
7 years ago
Will Thames c749ecbd94 Add ansible-inventory-grapher to the list of tools (#29068)
* Add ansible-inventory-grapher to the list of tools

* Fixed minor typo.
7 years ago
jhawkesworth 3d5320adad fix typo in new jsonquery filter example that uses backticks (#29082) 7 years ago
Adrian Likins 52f2edf19d 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.
7 years ago
Adrian Likins 89c973445c 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>`
7 years ago
Brian Coca f4fff54f68 clarify import_ docs (#28395)
* clarify import_ docs

* fixed izpellz

* Copy edits.
7 years ago
Will Thames 0d69b63c01 Additional simpler json_query documentation (#24041)
Since json_query treats backticks as delimiters for literals,
some of the examples in the json_query docs can be made a little
simpler. Rather than replacing such examples, demonstrate the
alternative
7 years ago
Brian Coca c3550b58ed introducing ALSO YAML inventory (#28596)
* introducing ALSO YAML inventory

* Copy edits
7 years ago
Brian Coca 48da0597c0 document ansible_group_priority (#28777)
* document ansible_group_priority

* Copy edit pass
7 years ago
Matt Clay fe90866819 Fix rst syntax issue in docs. 7 years ago
Dylan Silva ecc1fbcc1d updated modules support page with new information (#29071)
* updated modules support page with new information

* Minor wording tweaks.
7 years ago
Sam Doran 02a362e7de Replace rst extension with html in message (#29022) 7 years ago
Eddie Peters ea74176a28 Fix small typos and extra whitespace in the docs (#24559) 7 years ago
Sam Doran f0a0b630f6 Properly format inline code. 7 years ago
Ian Wienand 35d02b28c9 Minor syntax error in block versionadded
The syntax for versionadded is to have the string as a second
argument.
7 years ago
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
7 years ago
Pilou d67d202227 Fix typo: s/certfied/certified/ (#28951) 7 years ago
Toshio Kuratomi 13b2bedae6 Make python3 testing doc clearer for distro packaging users (#28948)
https://bugzilla.redhat.com/show_bug.cgi?id=1486612
7 years ago
Fran Fitzpatrick c51f2f835e Adds documentation for all the regex filters (#28944) 7 years ago
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
7 years ago
Scott Butler a9f82f8a8a Fixed incorrect version numbers. 7 years ago
Scott Butler c479d37777 Changed header to say 'devel' instead of 2.4 7 years ago
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.
7 years ago
Ron V 8999b98a09 Update playbooks_best_practices.rst (#26714)
fix point of confusion for newer users
7 years ago
Sam Doran cc7e38890c Clarify how tag inheritance works (#28942)
Fixes #20119

Another crack at PR #27147
7 years ago
Adrian Likins 933298505a Update places we mention env vars to use :envvar: (#28887) 7 years ago
Peter Sprygada ae2e84146e update network section for completed items (#28927) 7 years ago
Adrian Likins 28b9dc4bed Vault docs (#26979)
* start rst docs for ansible-vault encrypt_string

* wip, vault format docs

(sorta markdown ish atm)

* wip - formatting

* wip, vault docs

* Fix refs to other docs for now

fixing default_role in conf.py will remove need
for this

* add 'ref' to cli names

* more vault docs

* wip, misc fixes

* add some encrypt_string examples

* Fix up rstcheck warnings

The code blocks in question included the output that would
be echo'ed from running the command, which isnt valid bash.

* fix formatting and rstcheck warnings about code-block

* Add envvar ref for ANSIBLE_VAULT_PASSWORD_FILE

* fix doc title

* Fixed title underline
7 years ago
scottb b146e17733 Edit pass for relocated community documentation. (#28368)
* Edit pass for relocated community documentation.

* Updated info on Ansibullbot

Fixed improper link syntax
Change links to point to new documents
Changed Ansibot to Ansibullbot
Clarified workflow
Change formatting on commans and tags

* Update communication.rst

Add Contents
Use correct headings

* Update communication.rst

* Topics, remove whitespace, codeofconduct

* Formatting

* Correct heading

* Update maintainers.rst

* Minor edits and a request for more info

* Removed some hard-to-localize wording.

* Removed incomplete sentence

* Minor edits per review
7 years ago
Scott Butler c7c30c6760 Fixed wording. 7 years ago
Giovanni Sciortino d733f5af06 Add note in documentation and add warning related to retries parameter used without until (#28078) 7 years ago
Adrian Likins 8035e68d44 Generate a rst for config and env options from base.yml (#28739)
* wip, gen docs from config/base.yml

* wip

* dont change conf.py here

* cleanup, add dump_config --template-file cli opt

* some desc are string, some are lists...

TODO: fix base.yml so it is consistent

* Filter out TODO and empty descriptions
7 years ago
Sam Doran 80c00d3238 Create urlsplit filter (#28537)
* Improve tests for uri filter

* Create URL Split docs

* Add urlsplit filter

* Py3 compatibility

* Use helper method and eliminate query options

* Add options, cleanup output, fix tests

* Update docs

* Add parenthesis to boilerplate import

* Add debug task to tests

* Use exclude option to filter returned values

* Filter out additional option for Python 3
7 years ago
Matt Davis b3f2d1befe expose cloud_environment override in azure_rm modules (#28743)
* Can be set via env, credential profile, or module arg
* Valid values defined by Azure Python SDK, currently `AzureCloud`,`AzureChinaCloud`,`AzureUSGovernment`,`AzureGermanCloud` or any Azure Stack metadata discovery URL.
7 years ago
Chris Houseknecht d513c430de Updates community code of conduct email 7 years ago
Jason McKerr 9a2065fcf3 Update ROADMAP_2_4.rst 7 years ago
René Moser c97f4653be fix typos in various modules and docsite (#28747) 7 years ago
Jordan Borean 9b48c377b4 updated windows roadmap (#28740) 7 years ago
Reid Wahl ca91b361ce Fixes #28290: Added missing colon for paramiko host_key_auto_add line in network_debug_troubleshooting.rst (#28695) 7 years ago
Reid Wahl 3ca415f58c Fixes #21041: Add note to intro_inventory.rst that the Docker example is a playbook and not an inventory file (#28697) 7 years ago
Dag Wieers ccb6b39f45 Corrected RETURNS -> RETURN 7 years ago
Brian Coca 203d8d2e6e added diff keyword to changelog/docs 7 years ago
René Moser 6397e68bfd doc: replace play_hosts with ansible_play_batch (#28526) 7 years ago
Matt Clay 871bd24358 Fix documentation references. 7 years ago
Shane McDonald f108057f61 Bump version in docs layout (#28523) 7 years ago
Toshio Kuratomi 40ea448c7b Misc docs fixes
* Revise and link inline to the lists of modules

* Fix jinja2 objects.inv fallback path

* Fix bolding of deprecation marker

* Change module_support to link to lists via :doc:
  That links to the top of the page instead of a section.

* Add a short text for each list of maintained modules
* Change maintenance info to only display on core and network modules
7 years ago
Toshio Kuratomi 84ea2af4b6 Remove nonexistent special_interest-groups doc 7 years ago
Toshio Kuratomi 212499a489 On clean, remove the *_maintained.rst generated files 7 years ago
David Kretch beed59f303 Fix trailing space in ec2_vol example, fix 'the the' typos (#28440)
* Fix 'the the' typos, fix 'pahting' filename typo

* Change 'the the' typos to a single 'the'.
* Change `playbook_pahting.rst` to `playbook_pathing.rst`.

* Delete trailing space in ec2_vol example

Delete the trailing space in `instance: "{{ item.id }} "`, which makes the
example fail when run because it looks for instance "i-xxxx ".
7 years ago