Commit Graph

1062 Commits (7e9642113289b23ebe0bc679606f2c5fe74c2d9b)

Author SHA1 Message Date
Matt Clay 7e96421132
Handle warnings in docs-build sanity test. (#39043) 6 years ago
Matt Clay 4fc5e89e83 Fix docs build warnings. 6 years ago
Alicia Cozine 64dcc7def0 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
6 years ago
Alicia Cozine 408e29cbd2 Link fixes (#39038)
* fixes links on plugins pages

* fixes links in community pages

* fixes links in user guide

* adds anchors on playbooks pages
6 years ago
Toshio Kuratomi 6ddc64bc7c Fixes for multiline doc descriotions breaking rst formatting
* strip whitespace to preserve indent level
* Make sure to indent subsequent lines of indentation
6 years ago
Toshio Kuratomi a08459a814
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.
6 years ago
Alicia Cozine 0ebc0b9e5a adds FAQ TOC entry, links & examples to modules (#38706)
* adds FAQ TOC entry, links & examples to modules
* moves link to Notes, corrects examples
6 years ago
Toshio Kuratomi 8cdd75a09f 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
6 years ago
Brian Coca ce8c336d52 added ref to ansilbe molecule 6 years ago
Toshio Kuratomi 9faf7b949e Fix places in docs that refer to modules without namespace
We've namespaced all plugin docs.  Change the docs to reflect that
6 years ago
Toshio Kuratomi f9d83944ec regex for finding :ref: labels was flawed
The regex to find labels inside of angle brackets was not detecting
anything before so I missed all of those.
* Fixed the regex in find-plugin-refs to take care of that.
* Fixed plugin_formatter to emit namespaced labels for the M() macro.
6 years ago
Martin Krizek 8173602a34
Add expandvars jinja2 filter (#38805)
* Add expandvars jinja2 filter

* Add docs

* Minor edit
6 years ago
scottb c97e508806
[WIP] disambiguating autogenerated module docs attempted fix of #38439. (#38890)
Disambiguates autogenerated module docs - fixes #38439.
6 years ago
Matt Clay 3d57f45815 Update httptester docs. 6 years ago
Toshio Kuratomi a1b148d190 Fix shebang so sanity tests pass 6 years ago
Toshio Kuratomi 1f0cc54ec7 fixup style problems in new script 6 years ago
Toshio Kuratomi 6b1e6b8460 Add a script for finding bare plugin :ref:s
We're porting autogenerated plugin docs so that :ref: targets are
namespaced by plugin type.  To do this effectively, we need to know
where all the :ref: targets which refer to the bare plugin names are in
the rst files.  This script will find those.
6 years ago
Evgeniy Komissarov 92f4065157 Fix typo in windows_faq.rst (#38864)
Fix typo in `python-pip` packet name.
+label: docsite_pr
6 years ago
John R Barker 3d3781db57
Correct formatting (#38874) 6 years ago
Brian Coca bdbb89378f
centralize doc/config plugin lists (#38775)
* centralize doc/config plugin lists

also update list for generation in docsite
added note to ensure they are in sync

* updated shell page to list plugins

added some more docs hinting at plugins being configurable

* fix edit link for plugins
6 years ago
Kenyon Ralph 3c6a362921 playbooks_async.rst: correct typo 6 years ago
Rémy Léone d639d5dc96 Fix typo (#38652)
Typo
+label: docsite_pr
6 years ago
CsilLAB 521ea56e77 Add details to see decrypted vault value (#37341)
* Improves ansible-vault section of network getting started
6 years ago
Toshio Kuratomi 25523666ce 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
6 years ago
Matt Clay 26fa3adeab Add docs-build sanity test. 6 years ago
Will Thames 4ba29c8bf1 Use a temp directory that is more likely to exist (#38645)
`env:SystemDrive\temp` does not necessarily exist

`env:temp` is much more likely to exist. Use that
6 years ago
Qasim Sarfraz 6d830166e9 Minor typo fix (#38589) 6 years ago
Evgeni Golov 7376a9b946 fix with_<lookup> spelling (#38584)
trivial change ;)

+label: docsite_pr
6 years ago
Alicia Cozine da6d2b5f43 corrects Junos network_cli example & variables (#38601)
* corrects Junos network_cli example & variables

* vdacosta feedback, thanks
6 years ago
Alicia Cozine ea99cf3231 inaugural Network FAQ (#38359) 6 years ago
Martin Krizek 5297eac46d
playbooks_variables.rst: fix facts code-block (#38520) 6 years ago
Martin Krizek f1e41cbb36
playbooks_intro.rst: remove duplicite playbook (#38521) 6 years ago
scottb 6454aedb44
Reinstate code of conduct to the community TOC; add links to code of conduct to a few conspicuous spots in the community guide. (#38501) 6 years ago
alekseyp 061ecac3b5 Update playbooks_loops.rst (#38440)
Missing parentheses
+label: docsite_pr
6 years ago
Pierre Templier 1e0df01980 Small typos in docs (#38371)
* Small typos in docs

* Use same wording as in porting_guide_2.5.rst
6 years ago
Abhijeet Kasurde 8bc7af2e34 Minor typo in installation guide (#38452)
Change subsription-manger to subscription-manager

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
scottb d1d15dd025
Mobile CSS update - adds scrolling inertia (#38443) 6 years ago
Will Thames a8953fcac4 Add documentation on dict2items (#38375)
dict2items is worth mentioning in the filters and loops pages
(the latter as it's useful to replace `with_dict`)

Update some nearby broken links
6 years ago
scottb 785964ea97
Tweaks docs CSS to fix minor issue with main content page display cutting off at the bottom. (#38432) 6 years ago
Toshio Kuratomi f1b63f435e The ssh change note has been removed
Since the note was about 2.0 versus 1.x, this has been removed.  The
file implementing it is gone so we need to stop referencing it.
6 years ago
scottb 2381d2207e
Additional docs CSS fix for mobile (#38376) 6 years ago
scottb 79c5a34b0b
Fixes CSS so docs display properly on mobile (#38373) 6 years ago
Pierre Templier 2340ca7701 Small typos in docs (#38370)
* Small typos in docs

* Fixed wording
6 years ago
Elijah Lynn 95d40bcd0a Update fish setup to use `source` instead of `.` (#33207)
"The use of . is deprecated in favour of source, and . will be removed in a future version of fish."

source: https://fishshell.com/docs/current/commands.html#source
6 years ago
Brian Coca c62551c1b0 Update role doc examples (#37844)
* fix role examples

- also fixed issue with overload of 'name', fixes #37836
- attempted to clarify tag inheritance/application

* Typo fix
6 years ago
Brian Coca 5ad13d66aa documented actual precedence (#38009)
fixes #22025
6 years ago
Christian Fetzer 9cca9a9c10 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
6 years ago
Pilou 2a604f6fe6 doc: index_var: fix version added (#37982)
e9b0a4ccb4 is present since v2.5.0b1
6 years ago
Jonas Meurer 55fd3d62fb 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
6 years ago
Dag Wieers cdf9e39647 Fix the automatic docsite_pr label (#37999) 6 years ago