Commit graph

37 commits

Author SHA1 Message Date
Jens Heinrich
27eaab310b
Add direct link to using multiple inventory sources ()
This helps users to find the right ressources more easily and prevents them from clicking the first matching link only to be redirected to a subsection on the samepage from there

Co-authored-by: Jens Heinrich <github.com/JensHeinrich>
2021-03-11 14:36:00 -05:00
Jaime Hablutzel
afba5c2852
Miscellaneous fixes in user_guide/intro_inventory.rst docs ()
* Fixing missing hosts entry under the group dict.

* Added missing 'vars:' key

* Reordering arguments for consistency with the format displayed by "ansible-playbook --help"

* Fixing contradictory text
2020-10-20 10:35:15 -05:00
Andrew Klychkov
25bfda8417
Docsite: improve user_guide/intro_inventory () 2020-09-24 13:34:41 -05:00
Sandra McCann
bcfead8e0f change duplicated label 2020-09-21 12:32:11 -07: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
Eric G
13ab73cd89
Docs: ansible_host can contain FQDN () 2020-08-21 12:14:18 -04:00
Alicia Cozine
db354c0300
Docs: User guide overhaul, part 5 () 2020-07-14 17:00:44 -04:00
Allen
fb9740db4c
Specify numeric range can contain a stride ()
Updated the range creation example to show that you can also specify a stride value when creating a hostname by numeric range.
2020-06-16 11:31:00 -05:00
Jack Scheible
0ce404c4d9
Update intro_inventory.rst ()
Vars in inventory are merged in ASCII order. Change docs to reflect that.
2020-05-28 15:06:17 -05: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
Douglas Thor
46fea92125
Add note in inventory guide saying group names follow variable name guidelines. () 2020-05-04 16:09:44 -05:00
JP Mens
585e79942c
Slash missing from /etc/ () 2020-02-10 14:07:22 -05:00
Alicia Cozine
860cacc54f Docs: User guide overhaul, part 2 () 2019-12-12 13:35:17 -05:00
Hiroki Kobayashi
e7cd5af1a6 Update intro_inventory.rst ()
##### SUMMARY
A minor typo in `user_guide/intro_inventory.rst` is fixed.
Changed from "know" to "known"
2019-11-05 12:42:28 +05:30
Alicia Cozine
941a9b68fc Docs: User guide overhaul, part 1 () 2019-10-08 13:46:38 -04:00
Horst Gutmann
7047b66d34 Add examples for various inventory setups to the documentation ()
* Add examples for various inventory setups to the documentation. This closes .

* Update docs/docsite/rst/user_guide/intro_inventory.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/user_guide/intro_inventory.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update wording in inventory examples

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update wording in inventory examples

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Use code-block and rename groups in inventory setup examples

* Fix group name in inventory setup example

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-09-19 09:32:04 -04:00
Jiri Tyr
da18e3b76c Updating intro_inventory.rst () 2019-08-16 09:23:58 -05:00
Jiri Tyr
c4d841f848 Updating intro_inventory.rst () 2019-08-15 14:42:37 -05:00
Samy Coenen
0befccbeb9 Update intro_inventory.rst () 2019-07-09 15:56:21 -05:00
James Cassell
953058d025 standardize connection variable names ()
* standardize user/password connection vars

* docs: use ansible_user and ansible_password

* docs: var precedence for connection vars

* docs: ansible_become_pass -> ansible_become_password etc
2019-02-11 10:43:10 -05:00
kysamson
60d134aeaf Clarify priority setting in Inventory doc ()
* priority setting note in inventory doc

The `ansible_group_priority` variable is also described in *Using Variables* and was given a clarification in issue . The variable is also documented in *Working with Inventory* without the caveat that it needs to be declared on the inventory and not a group_vars file. This change adds that as a note

+label: docsite_pr
2019-01-29 14:44:31 -05:00
Sandra McCann
b023b89ec9 add example of hosts in multiple inventory groups ()
* add example of hosts in multiple groups

* fixed spacing

* added nested group example
2019-01-22 17:49:51 +01:00
Risto Oikarinen
b2f6259259 Add more detailed documentation on how to use multiple inventories ()
* Add a new section on how to use multiple inventory sources w/ examples

Co-Authored-By: zharalim <zharalim@outlook.com>
2018-12-20 15:45:41 -06:00
XOmniverse
5c525f9466 Update intro_inventory.rst to show YAML ranges ()
Adds a YAML example inventory listing a range of hosts to complement existing INI example.
2018-11-30 14:29:57 -06:00
Alicia Cozine
02baae6e99 revises inventory intro page ()
* revises inventory intro page

* changes :doc: to :ref: for links
2018-11-29 16:33:29 -05:00
Lars Kellogg-Stedman
220d224433 add note regarding {host,group}_vars directory lookup semantics ()
* add note regarding {host,group}_vars directory lookup semantics

While the 'ansible-playbook' command will look for {host,group}_vars in
both the playbook and inventory directories, the 'ansible' command
will only look in the inventory directory. This follows from a close
reading of the documentation but isn't explicit and leads to the
perhaps unexpected result that you can run both commands with the same
configuration in the same directory and get different results.

This commit adds a note to the documentation making the difference in
behavior explicit.

Closes 

* incorporates bcoca feedback
2018-11-09 15:22:23 -05:00
Brian Coca
8ccb44aa63 clarify insane ini typing ()
* clarify how variables are interpreted in the ini inventory plugin
2018-11-07 14:19:23 -06:00
Risto Oikarinen
f000baf6f7 Add yaml version of using host variables example () 2018-11-02 14:50:42 -04:00
Mark Phillips
76a0323918 Changed hash_merge to link for ANSIBLE_HASH_BEHAVIOUR ()
* Changed hash_merge, which goes nowhere, to link for ANSIBLE_HASH_BEHAVIOUR
* Changed link as per bcoca suggestion
2018-09-24 15:03:55 -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
saidmu
52fe9aaf04 Update intro_inventory.rst
<!--- I think a colon is missing-->

+label: docsite_pr
2018-07-10 12:08:21 -04:00
Adam Miller
21feca6683 Docs - add shared snippet note about password prompts for ssh keys ()
* Docs - add shared snippet note about password prompts for ssh keys

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

* add note to ssh connection plugin, fix markup, fix typo

Signed-off-by: Adam Miller <admiller@redhat.com>
2018-05-23 18:01:55 -04:00
Alicia Cozine
4b52a54e18 Reduce warnings ()
* removes FAQ links; no entries exist for linked config settings

* fixes various anchors and links

* addresses abadger comments, thanks

* marks orphan pages, avoids TOC errors

* adds links for remote_tmp setting to FAQ
2018-04-25 11:18:52 -07:00
Toshio Kuratomi
a08459a814
Update info on python support ()
* Update the documentation to list Python 3 as official
* Add some reference targets for inventory variables so we can link to docs
* Add a platform FAQ section
  Populate it with

  * virtualenv info (previously on the python3 support page)
  * BSD (Link to the working with BSD page)
  * Solaris (Document how to work around the non-POSIX shell on some
    Solaris hosts)

  Fixes 

* Fix some refs in the release_and_maintenance document

* Fix unindent error in module template

Fix for the module/plugin template unintentionally unindented inside of
a raw block, leading to errors like:

ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent.

* Make wording for Solaris troubleshooting better.
2018-04-18 13:04:47 -07:00
Michael
7fd74c2089 Fix typo in inventory docs () 2018-03-19 01:04:29 -07:00
scottb
381359a8f8
Doc build warning/broken link clean-a-palooza ()
* Doc build warning/broken link clean-a-palooza, WIP commit 1.

* Fixed broken anchor

* Fixing additional broken links; converting from doc to ref.

* Fix anchor
2018-03-14 12:44:21 -07:00
scottb
373b1dcf59
Core Docs Refactor and Redesign ()
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
2018-02-13 07:23:55 -08:00
Renamed from docs/docsite/rst/intro_inventory.rst (Browse further)