Commit graph

1097 commits

Author SHA1 Message Date
Dag Wieers
34113f6cc5 Docs: Fix highlight line (#50756)
(cherry picked from commit 646c34dcde)
2019-01-28 10:13:05 -08:00
Dag Wieers
a22f46bacf Docs: Add a "seealso" section to the module docs (#45949)
* Docs: Add a separate  "seealso" section to the module docs
to list related modules and/or related references. This clears up the notes
section for things that are actual notes.

So you can add a section in your module documentation and four types of
references are possible.

    seealso:

    # Reference by module name
    - module: aci_tenant

    # Reference by module name, including description
    - module: aci_tenant
      description: ACI module to create tenants on a Cisco ACI fabric.

    # Reference by rST documentation anchor
    - ref: aci_guide
      description: Detailed information on how to manage your ACI infrastructure using Ansible.

    # Reference by Internet resource
    - name: APIC Management Information Model reference
      description: Complete reference of the APIC object model.
      link: https://developer.cisco.com/docs/apic-mim-ref/

This PR also includes:

- Implements ansible-doc support
- Implements schema support for the seealso options
- Updates to the development documentation
- Rename filter convert_symbols_to_format to rst_ify, cfr the existing html_ify and tty_ify filters
  - This makes the existing template a lot easier to read and fixes the confusion I had myself rereading the template (again).
- We fixed the possible suboption types (which was limited to 'bool' only)

* Use latest stable instead of devel docs

(cherry picked from commit baf0ad2309)
2019-01-28 10:13:05 -08:00
Dag Wieers
f67081e97b Clarify gather_facts and highlight important lines
Clarify gather_facts and highlight important lines

+label: docsite_pr
2019-01-24 10:37:00 -08:00
Abhijeet Kasurde
f201aa8948 [Backport 2.7] VMware: Fix vmware_vm_inventory
* Added documentation around using vmware dynamic inventory plugin
* Fixed bug for populating host_ip in hostvars for given inventory host
* VMware: Add properties in vmware_vm_inventory

Fixes: #50249

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit af914695e6)
2019-01-14 12:35:21 -08:00
Sandra McCann
85764a00c4 link to KB article -certified modules (#50050) (#50052)
(cherry picked from commit b873f34ea3)
2018-12-18 12:16:30 -06:00
Martin Krizek
feb971f649 docs: remove not implemented password_hash feature (#49945) (#50008)
(cherry picked from commit 79947245e2)
2018-12-17 08:58:47 -06:00
Tim Burke
c7677eee83 Fix ReST formatting for Galaxy docs link (#49575)
(cherry picked from commit 6e43f9fe8f)
2018-12-06 11:00:57 -08:00
Matt Clay
7a0e86551d Support skip of platforms by version in tests. (#48826)
* Support skip of platforms by version in tests.

Previously a remote platform could be skipped completely using the alias:

`skip/{platform}` such as `skip/rhel`

Now a specific platform version can be skipped using the alias:

`skip/{platform}{version}` such as `skip/rhel7.6`

This feature is available for platforms specified with the `--remote` option.

* Add skip by version to the docs.

(cherry picked from commit 8066acc90c)
2018-12-03 15:42:03 -08:00
Xaroth
14fc00f28b [stable-2.7] -Change: set the 'canonical_url' theme option to enable rendering of canonical urls, promoting the 'latest' docs to search engines. (#49190) (#49214)
(cherry picked from commit 59e7a9442e)

Co-authored-by: Xaroth <xaroth+github@xaroth.nl>
2018-11-30 15:40:28 -06:00
Matt Martz
edae7b0524 [stable-2.7] Prevent metadata changes in a stable branch (#48994) (#49131)
* [stable-2.7] Prevent metadata changes in a stable branch (#48994)
(cherry picked from commit 7287d39)

Co-authored-by: Matt Martz <matt@sivel.net>

* Fix metadata comparison
2018-11-26 14:34:13 -06:00
John R Barker
eab6034c79 Update guide_packet.rst (#49007) (#49029)
Properly parses the returned data to get the device data and IP address.
(cherry picked from commit 679b7dce63)
2018-11-26 13:44:57 -06:00
Toshio Kuratomi
cef08640a4 [stable-2.7] Add an example to serial usage (#48669)
(cherry picked from commit b759862daa)

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2018-11-14 17:13:20 -08:00
Sandra McCann
093ab2170d fix toc issue (#48616) 2018-11-13 13:57:29 -06:00
Brian Coca
9389862d97 added faq entry on ansible_host + delegation (#48438)
(cherry picked from commit 7ca6af396e)
2018-11-12 19:30:18 -08:00
Abhijeet Kasurde
709845436e Update plugin filter documentation (#46665)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 6d36849f72)
2018-11-12 19:25:01 -08:00
Martin Krizek
64b6637a6f ansible-galaxy docs: fix init of container role (#47853)
(cherry picked from commit ec32bda2ef)
2018-11-05 15:10:52 -08:00
Alicia Cozine
dfdc7ec90c Updates variables docs: facts examples, headers, links, etc. (#47767)
* refreshes ansible facts output and updates some references/headers

(cherry picked from commit 7db63851e0)
2018-11-05 15:10:52 -08:00
Andrea Perotti
af18d3c451 Updates intro to dynamic inventory page (#46799)
* Added Foreman to the list of inventory scripts
(cherry picked from commit 8bc4a18500)
2018-11-05 15:10:52 -08:00
Alicia Cozine
b17142358a updates language about documentation versions and releases on index page (#46465)
(cherry picked from commit e97391b7ab)
2018-11-05 15:10:52 -08:00
Alicia Cozine
bc1d0f5e61 removes docs/api dir from .gitignore and Makefile (#47366)
* removes docs/api dir from .gitignore and Makefile

* reduces noise on removing build artifacts

(cherry picked from commit f1ad012375)
2018-11-05 15:10:52 -08:00
Alicia Cozine
86eb3b5b98 adds stub API docs in a single file (#46663)
* adds stub API docs in a single file

(cherry picked from commit 9764f32513)
2018-11-05 15:10:52 -08:00
Sloane Hertel
68aa3e24a8 cherrypick for #46786 2018-11-05 15:10:52 -08:00
Sloane Hertel
ed5f0d5c45 Add docs for inventory caching (#46402)
* Add docs for inventory caching

* Fix subsection headers

* Fix top header

(cherry picked from commit c4d1f0d416)
2018-11-05 15:10:52 -08:00
Deric Crago
58cd460952 moved 'strftime' filter into 'Other Useful Filters' section (#45801)
(cherry picked from commit 065b7ac300)
2018-11-05 15:10:52 -08:00
Sandra McCann
30acec79f4 Infoblox scenario guide (#45664)
* creates infoblox scenario guide
* adds link to infoblox guide from modules
* adds WAPI to prerequisites

(cherry picked from commit df3655968f)
2018-11-05 15:10:52 -08:00
Sandra McCann
3438429e22 WIP: fix build errors due to missing certified_supported label (#46835)
* fix build errors due to missing certified_supported label

* fixed references and toc

(cherry picked from commit db3d920cfd)
2018-11-05 15:09:42 -08:00
Abhijeet Kasurde
2f55215db2 VMware: improve readability and fix privileges names on scenario_clone_template (#47960)
(cherry picked from commit 89f03314ce)
2018-11-02 11:54:43 -05:00
Abhijeet Kasurde
c18eb52ade VMware: Fix documentation for cloning template (#47847)
Fixes: #46700

(cherry picked from commit ab0d90f882)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-11-01 10:13:09 -07:00
John R Barker
1bf3d54e01 Molecule is now IRC: ansible-molecule (#47860) (#47863)
(cherry picked from commit f536944e3a)
2018-10-31 09:34:01 -05:00
Abhijeet Kasurde
b8cc4a3046 doc: Scenario guide for VMware HTTP API usage (#47686)
This adds scenario guide for using VMware HTTP API using uri module.

(cherry picked from commit e5318c5c4f)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-10-30 15:18:12 -05:00
John R Barker
39e959eb0c [stable-2.7] bulk docs update (#47828)
* Document all Working Group, email lists and IRC channels (#47615)

(cherry picked from commit 749af9fd22)

* Docs: No need to follow up on backport PRs (#47616)

(cherry picked from commit 166e84b9c4)

* Tidy up Contributors Docs (#47619)

(cherry picked from commit 72359a10e6)

* Correct AWX community link (#47742)

(cherry picked from commit d189e58f63)

* ansible-lint and molecule part of Red Hat (#47826)

(cherry picked from commit 4572d9ccd7)
2018-10-30 14:45:41 -05:00
John R Barker
aaae3eb2c1 Adding a link for PR info (#47778) (#47820)
(cherry picked from commit e6d99cb2bf)
2018-10-30 14:41:25 -05:00
John R Barker
6cfdd9f466 Add docs about contributing to docs (#46481) (#47658)
* adds page on community contributions to docs

(cherry picked from commit 4219d25fc7)
2018-10-26 08:18:42 -05:00
Ganesh Nalawade
47f2352d33 Fix prompt mismatch issue for ios (#47004)
* Fix prompt mismatch issue for ios

Fixes #40884 #44463 #46082

*  If the command prompt is matched check if data is
   still pending to be read from buffer.
*  This fix adds a new timer `buffer_read_timeout`
   which will be trigerred after command prompt
   is matched and data is attempted to be read from channel.
   If not data is present of channel the timer will expire
   and response we be returned to calling function.

* Update doc

* Fix review comments

* Update changelog

* Fix unit test CI failure

(cherry picked from commit 335a979f1d)
2018-10-23 06:34:46 -07:00
Toshio Kuratomi
7812c065f4 Revert "Fix prompt mismatch issue for ios (#47004)"
This reverts commit 17cd01589a.

This commit was not passing CI.  Reverting
2018-10-22 18:33:58 -07:00
Ganesh Nalawade
17cd01589a Fix prompt mismatch issue for ios (#47004)
* Fix prompt mismatch issue for ios

Fixes #40884 #44463

*  If the command prompt is matched check if data is
   still pending to be read from buffer.
*  This fix adds a new timer `buffer_read_timeout`
   which will be trigerred after command prompt
   is matched and data is attempted to be read from channel.
   If not data is present of channel the timer will expire
   and response we be returned to calling function.

* Fix unit test failure

* Update to make buffer timeout float

* Update doc and fix review comment

* Fix CI issues

* Update doc

* Fix review comments

* Update changelog

(cherry picked from commit 335a979f1d)
2018-10-22 15:47:15 -07:00
Matt Martz
8810e9f9e2 [stable-2.7] Add porting guide note about inline vars on import/include_tasks (#47121) (#47130)
* Add porting guide note about inline vars. Fixes #47102
(cherry picked from commit abe6477)

Co-authored-by: Matt Martz <matt@sivel.net>
2018-10-17 10:50:52 -05:00
zharalim
3a02228b00 Clean playbook filters doc by adding whitespaces
(cherry picked from commit 1e23c79d18)
2018-10-15 09:58:33 -07:00
Matt Clay
7ce940cb41 Add symlinks sanity test. (#46467)
* Add symlinks sanity test.
* Replace legacy test symlinks with actual content.
* Remove dir symlink from template_jinja2_latest.
* Update import test to use generated library dir.
* Fix copy test symlink setup.

(cherry picked from commit e2b6047514)
2018-10-09 18:25:24 -07:00
Sloane Hertel
62b43ea28d Add 'auto' to documented default enabled inventory plugins (#46621) (#46637)
* Correct default inventory plugins enabled in docs and example/ansible.cfg

* Fix headers

(cherry picked from commit 43d12c11be)
2018-10-08 15:22:03 -05:00
Alicia Cozine
4fb5aa00a6 updates latest in docs conf.py (#46400)
(cherry picked from commit ba9348883b)
2018-10-03 22:16:46 -05:00
Sandra McCann
a1d1276b6e disable gather facts and update playbook output (#46409) (#46418)
* disable facts gather and update playbook output

* fix output

(cherry picked from commit a1fae193c7)
2018-10-02 16:23:10 -05:00
Sandra McCann
d81ed54ae6 Updates release & maintenance version docs for 2.7 (#46414)
(cherry picked from commit 04b726dc14)
2018-10-02 16:20:36 -05:00
Alicia Cozine
649403c3a1
yes, we do run validate_modules in Shippable (#46280) (#46283)
(cherry picked from commit 66eb5681f4)
2018-09-28 13:32:49 -05:00
Alicia Cozine
ac2ff94d43
Meraki scenario guide - Changed section markup types (#46158) (#46263)
* Changed section markup types, small fixes for style
- Add dashes per style guide
- Add TOC in case this grows

(cherry picked from commit a690917b5f)
2018-09-28 11:08:11 -05:00
Sandra McCann
6e86b317a9 Clean up Vault docs in User Guide. (#46188) (#46270)
- Fix spelling of 'separate' and 'algorithm'
- Fix indentation of nested list in payload format
- Fix mysterious refernce to 'b_pkey1'.
- Fix reference to newline as '\n': the backslash is lost when rendered
to the docs website. Specify the hex value for newline instead of the
backslash escape.

(cherry picked from commit ab96bbdef9)
2018-09-28 10:42:46 -05:00
Jordan Borean
7cce4dfbb0 add skip/docker alias to skip tests when running on Docker (#45955)
* add skip/docker alias to skip tests when running on Docker

* changed warning message wording

(cherry picked from commit 27c10fa502)
2018-09-27 12:50:06 -07:00
Kevin Breit
dc66eb07d0 [backport-2.7] Meraki scenario guide (#41827) (#45494)
* Meraki scenario guide (#41827)
(cherry picked from commit ec3ce1f39c)
2018-09-26 09:18:30 -05:00
Simon Metzger
8f93a0ec67 Update developing_modules_general_aci.rst (#46042) 2018-09-22 19:56:25 -05:00
Alicia Cozine
73bc121e11
added note about cli execution of include_x (#45227) (#45999)
(cherry picked from commit 03d8b68549)
2018-09-21 14:53:29 -05:00