Commit graph

1003 commits

Author SHA1 Message Date
Brian Coca
394753b918 Docs fix: ansible_group_priority defaults to 1 (#41204)
The docs committed in #28777 were inconsistent.
This clarifies that the default `ansible_group_priority` is `1`.[1][2]

[1] https://github.com/ansible/ansible/blob/153c9bd/lib/ansible/inventory/group.py#L40
[2] https://github.com/ansible/ansible/blob/153c9bd/lib/ansible/cli/inventory.py#L236

(cherry picked from commit 4fa2fb9c89)
2018-06-07 17:09:04 -07:00
Alicia Cozine
723dcea33e Make alias autodetection for symlinked modules independent of glob() order. (#40293) (#41266)
(cherry picked from commit 2a29b2ff7f)
2018-06-07 12:25:10 -07:00
Alicia Cozine
609c792072 Better error message if the template is not utf-8 encoded (#41030) (#41265)
* Better error message if the template is not utf-8 encoded

Also document this in the porting guide
(cherry picked from commit cef4d862bc)
2018-06-07 12:24:13 -07:00
Alicia Cozine
04a5fc5e5a Backport/2.5/39948 (#41094)
* Fix formatting error in rst plugin template (#38956)

The hyperlink syntax used is wrong and the resulting
rendered documents have broken links.

(cherry picked from commit aaf2ff629d)

* Add missing > to fix 'edit this document' link (#39067)

(cherry picked from commit ebdf6d0fab)

* Fix problems in documentation generation (#40050)

* Treat C(...) as inline literal (as opposed to interpreted text).

* Making test for true and false more precise, to avoid matching 1, 1.0, etc.

* The 'is sameas' test already takes care of definedness.

(cherry picked from commit f16933492d)

* Namespace the aliases ref target by plugin type (#38925)

(cherry picked from commit 7ce1afebf0)

* Use colspan on td instead of divs for hierarchical tables (#39948)

Address Firefox table-rendering issues in docs. Refactor to use colspan to provide table cells which can vary in width and indentation; the outermost has the greatest colspan, and each nested key has a colspan of one less than the parent, with padding cells for indentation.
Apply styling to table cells to get the table height to work without hacks or browser-specific
styling.  Simplify the markup and CSS by removing extra divs. Use two passes over the options, return values, and return facts in the Jinja2 module-docs template: one to determine the maximum nesting depth to compute the maximum colspan needed, plus one to lay out the rows.
(cherry picked from commit fa5c0282a4)
2018-06-06 13:32:02 -07:00
Brian Coca
a970ecba57 added information on keyword/vars separation (#39561) (#40895)
* added information on keyword/vars separation

fixes #39551

* updated as per fb

(cherry picked from commit bc93038943)
2018-05-30 16:12:54 -04:00
Alicia Cozine
b48b5c585e
adds table of connections by platform (#40688) (#40830)
(cherry picked from commit 43ca9d1548)
2018-05-30 08:17:04 -05:00
Alicia Cozine
7c49648a39
uses .txt for shared content (#40416) (#40538)
(cherry picked from commit 69eef14e3b)
2018-05-22 10:21:08 -05:00
Trishna Guha
b582ae6e29
documents usage of enable mode on NXOS (#39859) (#40221)
(cherry picked from commit 64f87867dd)
2018-05-16 13:33:59 +05:30
Brian Coca
e3b35d96be document lookup errors optoin (#39645)
* document lookup errors optoin

* changed to doc

* updated as per feedback

(cherry picked from commit 32c2aae258)
2018-05-15 15:30:12 -04:00
Jordan Borean
470f77e6dd
become win: better error messages and docs update (#39936) (#40122)
* become win: better error messages and docs update

* Fix syntax error and added changelog fragment

(cherry picked from commit e0813d7d47)
2018-05-15 10:49:36 +10:00
Alicia Cozine
256a85eefb
Update all pypi.python.org URLs to pypi.org (#38988) (#40119)
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
(cherry picked from commit 1d640182c6)
2018-05-14 19:19:10 -05:00
Brian Coca
448999f10e fix keyword doc generation
* use aliases when they exist
  * fix hardcoded loop attributes handling

(cherry picked from commit 19fee0ef41)
2018-05-10 16:45:08 -04:00
Ewoud Kohl van Wijngaarden
c4a9989c87
Fix code snippet in playbook filters doc (#39798)
(cherry picked from commit e4efc191c5)
2018-05-10 12:05:51 +10:00
Alicia Cozine
e1fde2a50f
Update call method for parse_cli_textfsm (#38437) (#39827)
+label: docsite_pr
(cherry picked from commit 7f5820274f)
2018-05-07 22:13:02 -05:00
Martin Krizek
00662ef044 Backport release_and_maintenance.rst (#39755)
* document our deprecation (#37788)

* document our deprecation

fixes #37779

* Copy edit.

(cherry picked from commit 8b45cab3c1)

* Update docs and version definitions for the 2.4.4 and 2.5.0 releases

(cherry picked from commit 73c80862c8)

* Fix 2.5 changelog link

(cherry picked from commit 4165bb308b)
2018-05-07 22:09:11 -05:00
Toshio Kuratomi
4d9895ad93 Document follow changes
Add the file, blockinfile, and replace changes to the follow parameter
to the porting guide

(cherry picked from commit 1885883a88)
2018-05-03 11:58:02 -07:00
Matt Clay
784956c219
Sync stable-2.5 test infrastructure with devel. (#39544)
Sync stable-2.5 test infrastructure with devel:

- shippable.yml
- test/runner/
- test/sanity/
- test/utils/
- docs/docsite/rst/dev_guide/testing/sanity/
- test/integration/targets/*/aliases
2018-05-01 15:47:24 -07:00
Matt Clay
e72ab67081 Fix broken docs link. 2018-04-30 15:57:44 -07:00
scottb
bb4c00c006 Copy edits and tweaks
(cherry picked from commit e7f9c5cc60)
2018-04-30 15:30:42 -07:00
Brian Coca
cc77752958 updated api example
- added many more comments
- removed very obsolete 1.x refs

(cherry picked from commit cf43e0d605)
2018-04-30 15:30:42 -07:00
Matt Clay
44247f95c3 Fix more docs errors. (#39051)
* Fix remaining unknown-document docs errors.
* Fix last toc-tree-missing-document docs error.

(cherry picked from commit 9e8889bb70)
2018-04-30 15:30:42 -07:00
Matt Clay
434c6ef7e8 Fix docs build warnings.
(cherry picked from commit 4fc5e89e83)
2018-04-30 15:30:42 -07:00
Alicia Cozine
27b1044bc1
Update intermediate_concepts.rst (#39500) (#39503)
Updated  GitHub Repos section to better explain what ansible-network@redhat.com is for (not an email list, but adding to the network-automation github repo.
(cherry picked from commit 9773157da6)
2018-04-30 11:35:53 -05:00
Brian Coca
b5a5211cd4 remove slice docs (#37946)
(cherry picked from commit b533ebe20d)

backport of #37946
2018-04-30 10:14:19 -04:00
Alicia Cozine
7577a8c24d
Last docs link fixes (#39391) (#39445)
* should not need <>, but fails without

* adds anchor to keywords page, uses it on plugins pages

* fixes envvar link errors

* harmonize file name and ref name as python_3

(cherry picked from commit c8a9b411bc)
2018-04-27 13:55:13 -05:00
Benn Roth
515bb78ee1 minor accuracy fix
Don't round the parameter 12.04 in the explanatory paragraph unless `version()` rounds the parameter

(cherry picked from commit 5cf544e03e5f833e1614fa940849976550d55448)
(cherry picked from commit 56967497d5)
2018-04-27 11:56:09 -04:00
Alicia Cozine
d1e6b9a199
Reduce warnings (#39254) (#39323)
* fixes from 4b52a54e18
* leaves out the stub 2.6 porting guide
2018-04-25 13:50:28 -05:00
Matt Martz
3bcca725fc
Documentation for query/q. Fixes #38275 (#38558) (#39316)
(cherry picked from commit 476d1f818e)
2018-04-25 13:34:19 -05:00
Alicia Cozine
f0761660bb
corrects links to 'list_of' pages (#39161) (#39230) 2018-04-24 12:27:26 -05:00
Alicia Cozine
b372eb0947
adds index page for roadmaps to support internal links (#39109) (#39192)
* adds index page for roadmaps to support internal links

* includes only roadmaps index page in TOC

(cherry picked from commit becc2a0347)
2018-04-24 08:46:32 -05:00
Alicia Cozine
1a96cd67d0 Internal refs (#39094)
* fixes community refs

* fixes appendix refs

* fixes scenario refs, keeps ACI guide link to devel

* fixes windows refs

* fixes user guide refs

* fixes dev guide refs

(cherry picked from commit bbfd6c6ab1)
2018-04-23 12:36:38 -07:00
Alicia Cozine
ea765be993 Link fixes (#39038)
* fixes links on plugins pages

* fixes links in community pages

* fixes links in user guide

* adds anchors on playbooks pages

(cherry picked from commit 408e29cbd2)
2018-04-23 12:36:08 -07:00
Alicia Cozine
3a0e8efc21 Fixes more rST errors (#39042)
* removes include, avoids duplicate label rST warnings

* reduces literal_block errors on playbooks_filters

* addresses TOC errors

* ref error on modules page

* trying ref for list_of_database_modules

(cherry picked from commit 64dcc7def0)
2018-04-23 12:35:37 -07:00
Alicia Cozine
628492f8b3 avoids not-in-toc errors with :orphan:
(cherry picked from commit 0fef3f1b48)
2018-04-23 12:15:59 -07:00
Toshio Kuratomi
0a7f2093a3 Update info on python support (#38855)
* 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 #21594

* 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.

(cherry picked from commit a08459a814)
2018-04-19 11:40:48 -07:00
Alicia Cozine
a2df7ab75e adds FAQ TOC entry, links & examples to modules (#38706)
* adds FAQ TOC entry, links & examples to modules
* moves link to Notes, corrects examples

(cherry picked from commit 0ebc0b9e5a)
2018-04-19 11:40:05 -07:00
scottb
5ec8a19b79 Reinstate code of conduct to the community TOC; add links to code of conduct to a few conspicuous spots in the community guide. (#38501)
(cherry picked from commit 6454aedb44)
2018-04-19 11:39:14 -07:00
Toshio Kuratomi
0e5c66ae72 Fixes for multiline doc descriotions breaking rst formatting
* strip whitespace to preserve indent level
* Make sure to indent subsequent lines of indentation

(cherry picked from commit 6ddc64bc7c)
2018-04-19 11:38:14 -07:00
Brian Coca
16f48b539f ensure cli dir exists before saving files to it
(cherry picked from commit 28015d8ae9)
2018-04-18 20:53:40 -07:00
Jonas Meurer
5ea8fa4052 Update porting_guide_2.5.rst (#37927)
The example regarding `include_*` is a bit unclear. First it seems like the v2.4 and v2.5 examples are the same. So I attempted to make the relevant change in the examples more obvious.

 label: docsite_pr
(cherry picked from commit 55fd3d62fb)
2018-04-18 10:08:58 -07:00
Toshio Kuratomi
d4be7f772a Some more fixes for the docs :ref: disambiguation
The big one is that we needed to set plugin_type when we processed the by_support template.

Also added to list_of_CATEGORY_plugins page (which might not be used)
and corrected a place where I did module_name instead of name_module

(cherry picked from commit 8cdd75a09f)
2018-04-18 10:06:44 -07:00
Brian Coca
07bb0407ad documented actual precedence (#38009)
fixes #22025
(cherry picked from commit 5ad13d66aa)
2018-04-18 10:02:37 -07:00
Christian Fetzer
529d778015 docs: Document disabling diff on task level (#37998)
* docs: Document disabling diff on task level

Tasks that deal with secrets may leak sensitive information when
running in Check Mode. This change updates the documentation explaining
that the diff can be deactivated on task level.

The feature was requested in #14860 and got introduced in Ansible 2.4
with #28581.

* Updated for clarity

(cherry picked from commit 9cca9a9c10)
2018-04-18 10:01:55 -07:00
Toshio Kuratomi
f670602448 Fix places in docs that refer to modules without namespace
We've namespaced all plugin docs.  Change the docs to reflect that

(cherry picked from commit 9faf7b949e)
2018-04-18 08:48:41 -07:00
Martin Krizek
751ae4f4a9 playbooks_variables.rst: fix facts code-block (#38520)
(cherry picked from commit 5297eac46d)
2018-04-18 08:44:27 -07:00
Toshio Kuratomi
003c52f1ef Modules that have a link to their own deprecated section need to use a different link syntax (#38697)
The :ref: syntax is for linking to targets which are defined for the
whole document tree.  `link`_ is for linking to targets which are inside
of the document.  We want the latter for deprecated sections because
otherwise we'd have to create namespaced link targets for them.

Also fix expansion of version a deprecated module will be removed in
(cherry picked from commit 25523666ce)
2018-04-18 08:28:59 -07:00
scottb
893807bfc9 [WIP] disambiguating autogenerated module docs attempted fix of #38439. (#38890)
Disambiguates autogenerated module docs - fixes #38439.

(cherry picked from commit c97e508806)
2018-04-17 18:49:27 -07:00
Toshio Kuratomi
4091ab479f Add alias's as a :ref: target for modules
This is especially important for deprecated modules as we want to link
to those in porting guides and such.

(cherry picked from commit 8f1b5fc47b)
2018-04-17 18:49:20 -07:00
Jordan Borean
9178def456
Fix typo in windows_faq.rst (#38864) (#38916)
Fix typo in `python-pip` packet name.
+label: docsite_pr

(cherry picked from commit 92f4065157)
2018-04-18 08:06:42 +10:00
John R Barker
f5befa5ab4
Correct formatting (#38874) (#38877)
(cherry picked from commit 3d3781db57)
2018-04-17 13:22:43 +01:00