Commit Graph

451 Commits (95e1d91d5d5120f5a6f219cb72064c8b91eda181)

Author SHA1 Message Date
Abhijeet Kasurde 8f6626bd8f Misc typo corrections
Fix adds correction for typos

* Anisble to Ansible
* Fasle to False

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
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
David Moreau Simard 022ce7efee Docs for multiple asynchronous tasks (#24457)
* Add docs on the behavior of with_items flattening and nested lists

* Add docs on limiting the amount of concurrent async tasks
7 years ago
David Moreau-Simard e9d6d37589 Update release status for 2.3 to 2.3.2 7 years ago
Peter Sprygada 2e44d8913b update parse_cli documentation with more examples (#28258)
* update parse_cli documentation with more examples
7 years ago
Tom Paine 50d744c217 Update playbooks_filters.rst (#28271)
See #17266, password_hash has been updated to support passlib. The available hashes are listed on http://docs.ansible.com/ansible/latest/playbooks_prompts.html, but not here.
7 years ago
Sam Doran b7aa38c0d8 Minor fixes to Developer Docs (#28302)
* Grammar and formatting corrections

Indent JSON code example.
Double backticks for inline code examples.

* Remove trailing spaces

* CI fixes
7 years ago
Matt Clay b52aeeabfa Roadmap updates and docs fix. (#28287)
* Update on 2.4 roadmap progress.
* Fix docs syntax for Python 2.
7 years ago
Toshio Kuratomi 546187a8af Revamp the plugin_formatter doc generator
* Use a template to generate the category lists
* Refactor so that we first extract all of the data that we need to
  build the docs and then give that data to the templates to build with
* Add docs page listing modules ordered by support level
7 years ago
Toshio Kuratomi af2073d057 metadata 1.1
* Add network value to support_by field.
* New support_by value, certified
* Deprecate curated in favor of certified
* Add conversion from 1.0 to 1.1 to metadata-tool
* Add supported by Red Hat field to ansible-doc output
7 years ago
CyberArk BizDev d50d65d448 Added cyberarkpassword lookup plugin (#21857)
* Added cyberarkpassword lookup plugin

Added cyberarkpassword lookup plugin: It allows to retrieve credentials
(password, sshkey) from CyberArk Digital Vault
7 years ago
Jason McKerr cc36153928 Update ROADMAP_2_4.rst 7 years ago
hsmtkk 3f9d6aa0f1 doc: fix a typo (#28215) 7 years ago
Aleks Daranutsa f668f41822 Spelling and Grammar for playbooks_reuse.rst (#28174)
* Spelling and Grammar for playbooks_reuse.rst

* Minor edits.
7 years ago
scottb b5179f9d46 CSS and HTML updates to enable versioned core documentation (#28097)
* Updated header for versioned docs.

* A tree in a golden forest.

* Fixed spacing.

* Fixed CSS and text for previous version header.
7 years ago
Toshio Kuratomi fe2e17f7cd Update the intersphinx cached indexes
In case we build docs offline, we want to have a cached copy of the
documentation refs that are in the intersphinx docs we reference.
Update those to the lattest versions from their respective upstreams
7 years ago
René Moser eec4434b9b doc: cloudstack: fix formating issue in guide (#28162) 7 years ago
Greg DeKoenigsberg d78c199972 Update triage_process.rst to link to ansibullbot (#28137)
* Update triage_process.rst to link to ansibullbot

* fix typo
7 years ago
Greg DeKoenigsberg 75c0c545fd Create other_tools_and_programs (#28138)
* Create other_tools_and_programs

From https://github.com/ansible/community/issues/5.

* Fix typo
7 years ago
Greg DeKoenigsberg b3ed699132 Copying code of conduct from community.rst (#28136) 7 years ago
Greg DeKoenigsberg 608c69279c Moving "communication" info from main community page (#28135) 7 years ago
Duncan Lock 9a2ae022f5 Format the versionadded block correctly (#28085)
Currently broken on the live docs site: http://docs.ansible.com/ansible/latest/playbooks_blocks.html
7 years ago
Prasad Katti 2c85ca3729 Formatting changes (#28133) 7 years ago
Greg DeKoenigsberg 5f6bfd81f8 Copying content from MODULE_GUIDELINES.md (#28131) 7 years ago
Adrian Likins a2c8b03b46 fix rst format errors making rstcheck fail (#28129) 7 years ago
Greg DeKoenigsberg 3ec7e030bf Completed draft of How Can I Help 7 years ago
Greg DeKoenigsberg f8f17c0c27 Add basic info on pull requests 7 years ago
Greg DeKoenigsberg 418dd0cd4a Iterating on How Can I Help
A little more content
7 years ago
Greg DeKoenigsberg ba065637ff Add roadmap to development process doc 7 years ago
Greg DeKoenigsberg 792bfa657c formatting tweak 7 years ago
Greg DeKoenigsberg e43d1da938 formatting tweak 7 years ago
Greg DeKoenigsberg d6028c5de4 Slight changes to reporting bugs and features
as recommended by @gundalow in review for #27911
7 years ago
Greg DeKoenigsberg ebfdbfb819 New content for bugs and features (#27911)
1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.)

2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
7 years ago
Stefan Midjich 6e4c0143b4 Typo in module example code (#28064)
In the DOCUMENTATION constant there is a typo on line 85 of this rst file.
7 years ago
Thomas Stringer e4cd899363 Add support for Azure 2.0.0 (#27920)
* Adapt azure_rm_resource_group to azure 2.0.0 + azure Cli support

* Fix exceptions in Azure ARM plugins

* update azure_rm_networkinterface documention to reflect required params

* change state param to not required for docs in azure_rm_subnet

* fix import to reflect azure==2.0.0 changes

* add aliases and fix docs for azure_rm_storageblob

* add resource_group_name alias to azure_rm_storageaccount_facts

* fix import bug due to change in azure==2.0.0

* fix args bug and enum modules issue

* update docs to reflect azure==2.0.0

* pin management clients to a specific api_version

* update docs to reflect the new azure-ansible-base python package

* add fallback for older api resource group listing

* rework azure dependencies installation

* refactor path joining to a cross-plat solution
7 years ago
Jordan Borean 7c59b66802 updated changelog for windows (#28040) 7 years ago
Brian Coca 914ae2fb26 added docs for undocumented play object entries 7 years ago
David Newswanger ebb1d75ee0 fixed a syntax problem that was preventing a warning box from being displayed 7 years ago
Prasad Katti 2a63693580 Minor fix in docs 7 years ago
Brian Coca 940a74a93a fixed include_role doc example (#27986)
fixes #27985
7 years ago
Dag Wieers 49aa64a5b8 Various small changes and adding myself
Unfortunately, the Github interface does no longer allow me to edit a file in the GUI and then branch it in my personal clone for making a PR. It now only offers to make a PR using a branch on the ansible repository :-(

So committing this directly instead against my will, but per the guidelines this appears to be safe. Fingers crossed...
7 years ago
Jordan Borean 362f032449 Changed docs requires to new format (#27918) 7 years ago
Joseph Miguel f88f4394c8 Update developing_api.rst (#25922)
* Update developing_api.rst

* Update developing_api.rst

Edited.
7 years ago
Arthur Kepler d828449611 Corrects default arg format used by datetime filter (#27612)
This ensures the default datetime format matches that of
datetime.datetime. Docs updated to match as well.
7 years ago
Toshio Kuratomi 44935a5db6 Add a (disabled) code-smell test for detecting _ variables
We are reserving the _ identifier for i18n work.  Code should use the
identifier dummy for dummy variables instead.

This test is currently skipped as someone needs to generate the list of
files which are currently out of compliance before this can be turned
on.
7 years ago
Peter Sprygada 2d5908255a add parse_cli and parse_cli_textfsm to documentation (#27755)
* add parse_cli and parse_cli_textfsm to documentation

* Minor edits.
7 years ago
Scott Butler c43a10bd69 Another clarifying note on Python supported versions. 7 years ago
Scott Butler 7d553aad29 Added note clarifying which version of Python 3 we support. 7 years ago
Scott Butler 699e0ccc32 Added note clarifying Python 3 supported versions. 7 years ago
Branko Majic f78baa1300 Implement ability to limit module documentation building (#24576)
* Implement ability to limit module documentation building:

- Added new option to plugin_formatter.py to support passing-in a list of
  modules for which the documentation should be built.
- Updated docuemtnation Makefile to allow specifying list of modules via
  environment variables (defaulting to all modules).
- Update instructions for building documentation and module development to
  include commands and description of limiting module documentation builds.

* Updated implementation for limiting module documentation building:

- Pass list of modules (or None) to list_modules function instead of string.
- Move conversion of module list to argument parsing code.
- No special keywords. Default ("") means build all modules. For no modules just
  specify non-existing module name.
- Updated documentation to reflect the changes.

* Updated implementation for limiting module documentation building:

- Use better default value, and don't treat "" as special case.
- Conditionally invoke different variants of command in Makefile instead of
  using special value "".

* Minor edits

Wording tweak
7 years ago
Scott Butler bfe470d391 Minor edit 7 years ago