Commit Graph

1241 Commits (a488b3a8edb89fd144bcc7b9342694265ea6143f)

Author SHA1 Message Date
Toshio Kuratomi 1885883a88 Document follow changes
Add the file, blockinfile, and replace changes to the follow parameter
to the porting guide
7 years ago
Anna Liao c812396793 Update playbooks_variables.rst (#39570)
<!--- Your description here -->

+label: docsite_pr
7 years ago
Abhijeet Kasurde 85ad2eae8a Fix typo in porting guides index page (#39582)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Matt Clay 054efb8d80
Update 2.6 roadmap dates. (#39573) 7 years ago
Andrew Gaffney 4134f1204b Add Andrew Gaffney to list of people in Committers Guidelines doc 7 years ago
Brian Coca 19fee0ef41 fix keyword doc generation
* use aliases when they exist
  * fix hardcoded loop attributes handling
7 years ago
Andrius Benokraitis 9773157da6 Update intermediate_concepts.rst (#39500)
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.
7 years ago
Alicia Cozine c8a9b411bc
Last docs link fixes (#39391)
* 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

* removes undefined-lable from ignore list
7 years ago
Abhijeet Kasurde 9f1254a32f Typo fix in testing link (#39407)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Matt Clay 32d786af65 Convert more http links to https. 7 years ago
Lucid One 40fcef3e41 Adding support for opensearch of documentation (#38593) 7 years ago
Jordan Borean f8853d83e3
windows: removed deprecated features in 2.6 (#38930)
* windows: removed deprecated features in 2.6

* Comma surgery.
7 years ago
Alicia Cozine 4b52a54e18 Reduce warnings (#39254)
* 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
7 years ago
Matt Martz 476d1f818e
Documentation for query/q. Fixes #38275 (#38558) 7 years ago
Matt Clay 7975c8fab0
Improve integration-aliases docs. (#39087) 7 years ago
Brian Coca b533ebe20d
remove slice docs (#37946) 7 years ago
Andrius Benokraitis 7881866db4 Update ROADMAP_2_6.rst with additional network roadmap items (#39225)
* Update ROADMAP_2_6.rst

Added network_get and network_put to Network modules roadmap

* Update ROADMAP_2_6.rst

add netconf_config to the network module roadmap
7 years ago
Alicia Cozine 8f83061e70 corrects links to 'list_of' pages (#39161) 7 years ago
Alicia Cozine becc2a0347 adds index page for roadmaps to support internal links (#39109)
* adds index page for roadmaps to support internal links

* includes only roadmaps index page in TOC
7 years ago
Alicia Cozine 0fef3f1b48 avoids not-in-toc errors with :orphan: 7 years ago
Matt Clay c262dbfd30 Use https for links to ansible.com domains. 7 years ago
saichint 6eecbf10e6 fix nxos_igmp_interface issues (#38752)
* fix nxos_igmp_interface issues

* shippable fix

* fix oif_prefix and oif_source

* shippable fix

* shippable fix

* shippable fix

* add an example for oif_ps

* review comments

* review comments

* more review comments

* fix typo
7 years ago
Josh aa9d7cb1f3 Update playbooks_debugger.rst (#39117)
Minor typo correction

+label: docsite_pr
7 years ago
Benn Roth 56967497d5 minor accuracy fix
Don't round the parameter 12.04 in the explanatory paragraph unless `version()` rounds the parameter

(cherry picked from commit 5cf544e03e)
7 years ago
Alicia Cozine bbfd6c6ab1 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
7 years ago
John R Barker c4e298b808 Correct to development_process (#39069) 7 years ago
John R Barker ebdf6d0fab
Add missing > to fix 'edit this document' link (#39067) 7 years ago
Salvatore Mesoraca aaf2ff629d Fix formatting error in rst plugin template (#38956)
The hyperlink syntax used is wrong and the resulting
rendered documents have broken links.
7 years ago
Matt Clay 9e8889bb70
Fix more docs errors. (#39051)
* Fix remaining unknown-document docs errors.
* Fix last toc-tree-missing-document docs error.
7 years ago
Matt Clay 7e96421132
Handle warnings in docs-build sanity test. (#39043) 7 years ago
Matt Clay 4fc5e89e83 Fix docs build warnings. 7 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
7 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
7 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
7 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.
7 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
7 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
7 years ago
Brian Coca ce8c336d52 added ref to ansilbe molecule 7 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
7 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.
7 years ago
Martin Krizek 8173602a34
Add expandvars jinja2 filter (#38805)
* Add expandvars jinja2 filter

* Add docs

* Minor edit
7 years ago
scottb c97e508806
[WIP] disambiguating autogenerated module docs attempted fix of #38439. (#38890)
Disambiguates autogenerated module docs - fixes #38439.
7 years ago
Matt Clay 3d57f45815 Update httptester docs. 7 years ago
Toshio Kuratomi a1b148d190 Fix shebang so sanity tests pass 7 years ago
Toshio Kuratomi 1f0cc54ec7 fixup style problems in new script 7 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.
7 years ago
Evgeniy Komissarov 92f4065157 Fix typo in windows_faq.rst (#38864)
Fix typo in `python-pip` packet name.
+label: docsite_pr
7 years ago
John R Barker 3d3781db57
Correct formatting (#38874) 7 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
7 years ago
Kenyon Ralph 3c6a362921 playbooks_async.rst: correct typo 7 years ago
Rémy Léone d639d5dc96 Fix typo (#38652)
Typo
+label: docsite_pr
7 years ago
CsilLAB 521ea56e77 Add details to see decrypted vault value (#37341)
* Improves ansible-vault section of network getting started
7 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
7 years ago
Matt Clay 26fa3adeab Add docs-build sanity test. 7 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
7 years ago
Qasim Sarfraz 6d830166e9 Minor typo fix (#38589) 7 years ago
Evgeni Golov 7376a9b946 fix with_<lookup> spelling (#38584)
trivial change ;)

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

* vdacosta feedback, thanks
7 years ago
Alicia Cozine ea99cf3231 inaugural Network FAQ (#38359) 7 years ago
Martin Krizek 5297eac46d
playbooks_variables.rst: fix facts code-block (#38520) 7 years ago
Martin Krizek f1e41cbb36
playbooks_intro.rst: remove duplicite playbook (#38521) 7 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) 7 years ago
alekseyp 061ecac3b5 Update playbooks_loops.rst (#38440)
Missing parentheses
+label: docsite_pr
7 years ago
Pierre Templier 1e0df01980 Small typos in docs (#38371)
* Small typos in docs

* Use same wording as in porting_guide_2.5.rst
7 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>
7 years ago
scottb d1d15dd025
Mobile CSS update - adds scrolling inertia (#38443) 7 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
7 years ago
scottb 785964ea97
Tweaks docs CSS to fix minor issue with main content page display cutting off at the bottom. (#38432) 7 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.
7 years ago
scottb 2381d2207e
Additional docs CSS fix for mobile (#38376) 7 years ago
scottb 79c5a34b0b
Fixes CSS so docs display properly on mobile (#38373) 7 years ago
Pierre Templier 2340ca7701 Small typos in docs (#38370)
* Small typos in docs

* Fixed wording
7 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
7 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
7 years ago
Brian Coca 5ad13d66aa documented actual precedence (#38009)
fixes #22025
7 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
7 years ago
Pilou 2a604f6fe6 doc: index_var: fix version added (#37982)
e9b0a4ccb4 is present since v2.5.0b1
7 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
7 years ago
Dag Wieers cdf9e39647 Fix the automatic docsite_pr label (#37999) 7 years ago
Sam Doran 34dca85417 Update installation docs for RHEL based distributions. (#38056)
Upstream rpms are no longer in Extras but EPEL as well as releases.ansible.com.
Add instructions for adding Ansible Engine repo to RHEL.
7 years ago
ewubnhn ea9ece8e72 Update spelling_word_choice.rst (#38113)
Added missing format string on "Installer"

 label: docsite_pr
7 years ago
Alicia Cozine 24fe8674a6 DOCS: Network Best Practices fixes (#38293)
* fixes typo per #38217, corrects link anchor

* adds ssh-agent info per #35649
7 years ago
Scott Butler 62c2b9a544 Removes modules from TOC, speeding up build time and reducing doc disk space requirements. 7 years ago
Toshio Kuratomi 4165bb308b Fix 2.5 changelog link 7 years ago
Toshio Kuratomi 8f1b5fc47b 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.
7 years ago
Toshio Kuratomi 73c80862c8 Update docs and version definitions for the 2.4.4 and 2.5.0 releases 7 years ago
Dylan Silva 45b5a486c6 2.6 roadmap doc (#37926)
* 2..6 roadmap doc

* Formatting & network items

* typo
7 years ago
Alicia Cozine 380c074808 demonstrates best practices for group vars (#37930)
* demonstrates best practices for group vars

* removes vm-specific var from example

* adds brackets to all [group:vars] refs
7 years ago
scottb 68f81a6799
Reinstated element to fix doc display on mobile devices. (#38246) 7 years ago
Matt Martz a89d0d0919
Ensure that arguments for sub commands are properly indented (#37992) 7 years ago
Dag Wieers 70d49f7616
Fix indentation issue
<!--- Your description here -->

+label: docsite_pr
7 years ago
Sam Doran b5b3beff83 Correct syntax highlighting in plugin dev docs (#38184)
Use rst em dash
7 years ago
Daniel 45e4dfda3d doc: fix grammar (#38145) 7 years ago
Alicia Cozine b72960fdd4
revises network portion of 2.5 porting guide (#37938)
* revises network portion of 2.5 porting guide
7 years ago
Colin Walters 290cca3613 docs/keywords: Clarify `async` a bit (#37943)
I hastily did a copy/paste of the `async` example and it took me
a while to understand that `async` specified a maximum runtime in seconds.
The docs are actually mostly clear on this, but I made this PR while
reading the code.

This also fixes the spelling of "asynchronously".
7 years ago
Joseph Herlant 00a7ff7974 Move man pages generations to rst2man (#37861) 7 years ago
Matt Martz ffbbb5a25b
Use arg_spec type for comparisons on default and choices (#37741)
* Use arg_spec type for comparisons on default and choices

* Further improve type casting

* Make sure to capture output in more places

* Individually report invalid choices

* Update ignore.txt after resolving merge conflicts
7 years ago
scottb 3554e2c2d9
Fixes scrolling issue without breaking header nav (#37864) 7 years ago
scottb 47318a50b2
Temporary fix for horizontal scrolling issues on certain pages. Note that this will revert the behavior where headings scroll off the top of the main content region during navigation; fix for that is being investigated. (#37863) 7 years ago
Pilou 56d0721bd9 doc: modules involving file transfert bypass pipelining (#37250)
* doc: modules involving file transfert bypass pipelining

* Fixed typo
7 years ago
Martin Krizek bcfff1c818 docs: needs_rebase is still used (#37774) 7 years ago
Dag Wieers 69c0f96112 Fix nested parameters in module docs (#37793) 7 years ago
Brian Coca 8b45cab3c1
document our deprecation (#37788)
* document our deprecation

fixes #37779

* Copy edit.
7 years ago
Brian Coca 68e7045a38
try to clarify run_once and forall! (#37754)
* try to clarify run_once and forall!

* fixed hidden tls middle man

* make when note

* Minor edit

* Typo fix
7 years ago
Brian Coca 40a55e9f55 update vars info (#37729)
- remove 1.x references
- update directives to keywords as this is the accepted naming for them
7 years ago
Ryan Pineo fe87869cec Fix casing on CallbackBase in 2.4 porting guide (#37616) 7 years ago
Brian Coca 06b70f1614 Revert "Add a few Jinja2 tests to simplify template (#37514)"
This reverts commit b8e07f0d6e.
7 years ago
Dag Wieers b8e07f0d6e
Add a few Jinja2 tests to simplify template (#37514)
Add list test to simplify template
7 years ago
scottb 57da6319e1
Adds VMWare to TOC; sort scenario guides alphabetically (#37661) 7 years ago
Owen Kuemerle ba4f26313b Correct method to get timedelta seconds value (#37485)
* Correct method to get timedelta seconds value

This also adds additional clarification for extracting different time/date values for time deltas

* Small edit
7 years ago
Brian Coca 64dfaf9cda removed deffered items (#37541) 7 years ago
Michael 7fd74c2089 Fix typo in inventory docs (#37577) 7 years ago
scottb 0a6b951447
Fixes anchors scrolling off the top of the screen during navigation. (#37548) 7 years ago
Arbab Nazar 775e8ed806 fix the typo
<!--- Your description here -->

 label: docsite_pr
7 years ago
Dag Wieers 3cc362d958
Add missing YAML escape characters
These were missing after review PR #37486

 label: docsite_pr
7 years ago
Dag Wieers e691e07646 Fix boolean input and string-type validation 7 years ago
Abhijeet Kasurde 71e85a45c1 Add missing single quote in inventory_plugin doc (#37403)
Added missing single quote in inventory_plugin doc.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Robert de Bock 0cf2ecbc62 Update porting_guide_2.5.rst
A fix to a minor typo. ("Previouslu" -> "Previously")

 label: docsite_pr
7 years ago
scottb 381359a8f8
Doc build warning/broken link clean-a-palooza (#37382)
* 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
7 years ago
Dag Wieers 80ba7b7402 Various module doc fixes (#37256)
This PR includes:
- A fix for multiple-choice defaults
- A fix for messed up dictionary samples
- Cleaner defaults when they don't appear part of choices
7 years ago
Toshio Kuratomi fafcb3452f
Porting guide (#37226)
* Add the lookup plugin strictness to the porting guide

* Edited for clarity.

* Wordsmithing.
7 years ago
Dag Wieers 8f2c87231f Ensure the table spans the complete page width (#37129) 7 years ago
Dag Wieers 6636401246 Improve default values and choices in module docs (#36901)
* Improve default values and choices in module docs

So currently we show defaults and choices in separate columns.

For each parameter we have
- Mostly empty default and choices cells
- A list of choices and a separate default value
- Only a default value

So there's a lot of space being wasted on empty cells.
We can do this better.

* Improve Parameters section

* Add Choices back into column header

* Ensure the tables spans the complete page width
7 years ago
Alexander Lex 19f92005b9 Update developing_api.rst (#37108)
Fix for #17716 and #36110
7 years ago
Pierre-Louis Bonicoli 5d410c2c69 doc: 2.3.3 has been released
Sources:
https://github.com/ansible/ansible/releases/tag/v2.3.3.0-1
https://pypi.python.org/pypi/ansible/2.3.3.0
7 years ago
John R Barker ff28429e2a
Network doc items that are done 7 years ago
Adam Miller 3fd5b0740e allow ANSIBLE_KEEP_REMOTE_FILES for local test runner (#33357)
* allow ANSIBLE_KEEP_REMOTE_FILES for local test runner
* add ANSIBLE_KEEP_REMOTE_FILES to tox.ini, update docs
* Clarify handling of environment variables.
7 years ago
Dag Wieers eb52a88fb6 Improve module docs return values (#36943)
* Improve module docs return values

Currently the 5 columns shown doesn't make optimal use of the screen
estate, especially for facts modules this is a problem.

* Add returned facts as a separate section

* Remove whitespace and add support section

Since Notes were moved higher up, the Author, Status and Maintainer
information was now placed under the Return Values section.

* Switch Last Updated and Copyright
7 years ago
John R Barker 7a4e270ae0
Link to new network platform pages (#37057)
Also fix a few broken links
7 years ago
Dag Wieers bcdaba57b5 Remove Sphinx/Read-the-Docs plug on every doc page (#37023)
* Remove Sphinx/Read-the-Docs plug on every doc page

No need to have this on every page.

This fixes #37021

* Reinstated RTD credit with revised wording.

* Re-removed RTD footer boilerplate.
7 years ago
Dag Wieers cb79957b5f
Make use of named links in documentation notes (#37027)
* Make use of named links in documentation notes

Now that it is possible to name external links, we are making use of
this to make the documentation better.

* Add improvements to ACI documentation

* Disable QA for long line

* Add :menuselection: and :guilabel:

* Improve links on some modules
7 years ago
John R Barker 0a2dda2060
Support <hr/> in module docs (#37030) 7 years ago
John R Barker 985f09270d
Ability to link to other pages from plugin docs (#37009)
Support relative links
7 years ago
scottb e7f9c5cc60 Copy edits and tweaks 7 years ago
Brian Coca cf43e0d605 updated api example
- added many more comments
- removed very obsolete 1.x refs
7 years ago
Dag Wieers 6601e78dfa
Wrong syntax 7 years ago
scottb f923299fe8
Adds the ability to override the doc build output directory from the command line. (#36604)
* Adds the ability to override the doc build output from the command line.

* For safety, removed straight rm of BUILDDIR and removed subdirectories instead.

* Added check to see if BUILDDIR was defined to main makefile
7 years ago
Russ Starr 4a6758b74f Update playbooks_filters_ipaddr.rst (#36883)
Fixed a typo since the example should be referencing the newly defined list.
7 years ago
Alicia Cozine 4f63123320
Network Platform docs (#36814)
* introduces platform docs
7 years ago
Dag Wieers eae0aa0592 Automatically stuff reference in commit message (#36844)
* Automatically stuff reference in commit message

So we probably want to track which edits were performed through the
Github interface, and this change automatically adds a label to the
commit message.

```yaml
<!--- Your description here -->

+label: docsite_pr
```

Eventually this allows to (on regular basis) list the changes from
documentation readers and process them in a separate process.
7 years ago
Dag Wieers 629278464f Improve contribute-message in document footer (#36841) 7 years ago
Dag Wieers 3b27d723fb Fix indentation of requirements (#36813)
Just discovered that the requirements were indented, whereas all other
lists were not. This makes them stand out for no good reason.
7 years ago
Dag Wieers 38abda544f Improve module docs wrt. required params (#36812)
So I am still not satisfied with how required parameters are being
displayed (before it was yes/no, then it became required/optional, and
only required).

Now it will display in small green 'required' under the parameter name.
This is more convenient, and provides more room for the description.
Especially on smaller screens.
7 years ago
Dag Wieers 974c50a417 Move notes higher up in order (#36815)
So people reading the module documentation usually look for parameters
first, and are interested in examples. However the notes are at the very
end even below the Return Values (the least interesting part).

So this change moves the notes higher up, below parameters, but before
examples so people at least see the notes.
7 years ago
John R Barker 41c066eff9
Fix broken links (#36864) 7 years ago
Daniel Andrei Mincă 8362ddd107 clarify the slicing example (#36842)
As stated by fellow contributors, update the slicing example

Resolves:
Related: #36625
Signed-off-by: Daniel Andrei Minca <mandrei17@gmail.com>
7 years ago
John R Barker 3911b9c53a
typo 7 years ago
John R Barker b3c64ecd09
khjh
j
7 years ago
Antonio Quinonez de7692b1c9 Explain what the Ansible Quickstart video does (#36453)
* Explain what the Ansible Quickstart video does

Rewrote what video does. The video is really not teaching you how to do the work. It explains why you'd want to use Ansible and shows you what it takes (some sample code) . Video also introduces you to other products in the Ansible ecosystem.

* Edit
7 years ago
Dag Wieers 50e989f906 docs: Workaround for non-string values (#36720)
* Workaround for non-string values

So I think the proper fix should go into html_ify, which should convert
any value into a string, rather than expecting strings only.

* My preferred solution
7 years ago
Wolfgang Felbermeier 9c81b5d92b Fix table display width. (#36728) 7 years ago
Brian Coca 7a81d5f11e removed now irrelevant section
fixes #35760
7 years ago
Matt Clay 3937082892 Fix rst link syntax. 7 years ago
Kevin Breit 487ff1fe9b Fix typos (#36671)
Fix minor typos
7 years ago
Dag Wieers 8f6eea50db
More improvements to ACI module docs (#36689)
* More improvements to ACI module docs

* Asorted improvements

* Found 2 more

* Improvements to aci_rest documentation
7 years ago
Dag Wieers 4ff0317f3e
Improve module doc parameter list (#36688)
This PR includes:
- Indentation of Jinja constructs
- Put parameter name in bold
- Title-case table headers
- Show 'required' when parameter is required (not yes/no)
- Left-align all values
7 years ago
Dag Wieers 97fde8c760
ACI: Asorted fixes to documentation (#36681) 7 years ago
Dag Wieers 7cf08e9986
Improve parameter required values and ref fix (#36680)
This PR includes:
- An improvement to the parameter listing, where instead of yes/no, it
  is indicated with required/optional (easier when scrolling through a
  long list of parameters)
- Ensure that module reference, eg. M(foobar) do not include the module
  document title
7 years ago
Dag Wieers e520ff2e99
docsite: Improve previous fix for smartphone/tablet (#36678) 7 years ago
Dag Wieers 5da948f792
Fix rendering docsite on smartphone/tablets (#36675) 7 years ago
Dag Wieers 8a040415f9
Fix module references in module docs (#36674) 7 years ago
Dag Wieers 3016bc7351
Asorted docs fixed (#36672)
This PR includes:
- A fix to untemplated {{ plugin_type }} in docs
- Remove the additional info on how to edit module docs (see #36667)
- Add missing delimiter
7 years ago
Dag Wieers ba370b178d
docsite: Add 'Edit on GitHub' for module docs (#36667)
This is something I always wanted, a 'Edit on GitHub' button for module
documentation.

I also removed the additional statement in the footer with instructions
on how to edit the module documentation.

PS The links go directly into the GitHub file editor now !
7 years ago
Dag Wieers fde4cc6219
guide_aci: Fix a few references (#36666) 7 years ago
Brian Ong 1abc47c5d3 Fixed indentation error in `facts-demo.yml` example. (#36645)
* Fixed indentation error in `facts-demo.yml` example.

`content` and `dest` should be indented under the `copy` module.

* Updated indentation of copy module in `facts-demo.yml` example.

Updated indentation of copy module in `facts-demo.yml` to be inline with its name.
7 years ago
Dag Wieers 7da7ba79bc Add anchors to some guides and all module categories (#36642)
* Add anchors to some guides and all module categories

This is required if we want to use *absolute* :ref: references instead of *relative* :doc: references.

* Update the Cisco ACI Guide reference

* Add `aci_guide` anchor

* Add `network_guide` anchor

* Add category anchor

* Improve readability

* Fix small typo
7 years ago
Matt Martz 076ea07bb5
Add instructions for creating backport PRs (#36593)
* Add instructions for creating backport PRs

* Update development_process.rst

simpler workflow

* Update development_process.rst

added origin note

* A few adjustments to clarity, use backport instead of cherry pick in branch name

* Address formatting issue

* fetch isn't a flag

* Fix rst formatting
7 years ago
Daniel Andrei Mincă 62f237f21e fix erroneous example in inventory (#36625)
After initializing a list in both Python2/Python3 with below elements,
I've tested the indexing and realised that the examples provided in the
documentation are erroneous.

As a result, update the examples with correct values in order to avoid
any future confusion.

Resolves:
Related:
Signed-off-by: Daniel Andrei Minca <mandrei17@gmail.com>
7 years ago
Alicia Cozine 51a010a696 Network Getting started docs (#36337)
* first draft of getting started guide
7 years ago
Dag Wieers 7435e115e0
ACI: Various changes to module documentation and guide (#36516)
* ACI: Various changes to module documentation and guide

This PR includes:
- We moved the object class information to the notes
- Add version information to guide chapters
- Add generic note to modules with reference to ACI guide
- Reference known issues in aci_rest documentation
- Remove module_utils function docs from modules
- Indicate which parameters are not required for querying all objects
- Added missing RETURN information

* Fix copyright strings

* Remove aci_domain_to_encap_pool.py for v2.5

* More updates

* PEP8 fix

* Improve listings of parameters/return values
7 years ago
Klaas Demter ce80485ecd [Doc] Update Conditional Imports (#35492)
* [Doc] Update Conditional Imports

facter/ohai is not needed for the ansible internal facts
also fix that os_family for centos is redhat

* Copy edit.
7 years ago
Matt Lee 75ab070c63 Update vault.rst (#36328)
hunter2 not hunter42. http://bash.org/?244321
7 years ago
Ganesh Nalawade b57cc7cf31
Update network debug troubleshooting guide (#36288)
* Update network debug troubleshooting guide

Fix #35914

Command timeout and connection timeout error messages
are dsiplayed in log file instead on console.
Update the same in troubleshooting guide.

* Update example error

* Fix CI issues

* Fix more CI failures

* More fixes

* Fix review comments

* Fix more review comments

* Copy edit
7 years ago
Dag Wieers 79d00adc52
aci_rest: Fix error handling and improve documentation (#36295)
This PR includes:
- A fix for a recently introduced issue wrt. error handling
- Added integration tests for provoked errors
- Influence standard return values using aci library for aci_rest
- Add proxy support documentation
- Documentation update related to #34175
7 years ago
John R Barker f77a390131
Depreciate aos (#36029)
* Deprecate Apstra's aos_* modules

These modules don't work with AOS 2.1 or higher.
They will be replaced non-upstreamed modules

* Correct list
7 years ago
Brian Coca 3eff279dd7 updates to module testing (#36043)
* updates to module testing

gives those using internal modules an alternative

* Copy edit
7 years ago
Brian Coca 1f363a6a7c updates to porting guide (#36219)
* updates to porting guide

(cherry picked from commit 7a6d6870d4633ae38a14cc799521b5fc1c0320fd)

* Edits to correct spelling, grammar, and clarify wording.

* Fixed typo
7 years ago
Matt Martz 50adc5409b Add several new doc<->arg_spec checks (#36247)
* Add several new doc<->arg_spec checks. See #18183

* Update ignore.txt for validate-modules
7 years ago
John R Barker 577ff4d949
Add stub porting_guide_2.6.rst (#36190)
* Add stub porting_guide_2.6.rst

* Typo fix
7 years ago
scottb 1f609f8be3
Cleaned up some scenario guide titles and TOC placement. (#36225) 7 years ago
scottb 391896ca9d
Fixed typo in link. (#36220) 7 years ago
David Newswanger 3f5caf659e added support for --testcase flag in ansible-test (#36134)
* added support for --testcase flag in ansible-test

* fixed command format

* added tab completion

* fixed sanity issues

* added documenation for --testcase

* don't autocomplete when multiple modules are selected
7 years ago
Brian Coca 0cf70a8970
never tags docs and test (#35964)
* fufilling the promise

* moved changes

* Copy edit
7 years ago
scottb c5dd0d97af
Relocate ACI guide and add to TOC (#36208) 7 years ago
scottb dc902a5022
Fixes broken nested tables in module docs (#36144) 7 years ago
Brian Coca 28015d8ae9 ensure cli dir exists before saving files to it 7 years ago
Brian Coca 5a0f4f0646 removed gnerated files
@dharmabumstead, probably need a few more of these
7 years ago
Patrick Fink 43eb97ef92 Fix typo in vars.rst (#35098) 7 years ago
scottb c10080bfba
Followup to docs refactor pull request #36067 - fixes gitignore and c… (#36120)
* Followup to docs refactor pull request #36067 - fixes gitignore and cleanup in makefile; removes some generated files; moves a straggler to the appropriate subdirectory.

* Fixed some stragglers

* Removed redundant module entries

* Delete generated RST files.
7 years ago
scottb 373b1dcf59
Core Docs Refactor and Redesign (#36067)
* 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
7 years ago
John R Barker 480a9c10c9
Consistant headings (#36112) 7 years ago
Dag Wieers a875363e35
ACI docs: Add more links to resources and community (#36101)
This PR includes:
- Adding more resources to each section
- Improving wordings
- Add links to the Ansible ACI community pages
7 years ago
Dag Wieers 218f008dab
ACI docs: Add a section about common error messages (#36088)
Since we pass information directly to ACI, we sometimes get error messages back to the user that require some additional information or context.

This PR includes:
- Changes to the default error output so the error is easier to find
  when searching in e.g. Google
- 3 specific error messages that we have encountered and has confused
  our users before
7 years ago
Matt Davis 5f68892e81
requested status updates/removals of punted items 7 years ago
Rvgate d5ae63c0ea Change wording of Going Further section (#35949)
* Change wording of Going Further section

The original wording was confusing with its non-devel branch part.
Made it much clearer for people to understand what to do.

Also removed the git command for creating branches, I believe a
develop should be aware of how basic git commands work.

* Edited for concision and clarity.

* Typo fix

* Typo fix
7 years ago
John R Barker c3523cdd60
Test against a single transport (#35903)
Network integration tests can use tags to run only a specific transport
7 years ago
Dag Wieers 80e1e0b017
ACI: Assorted set of fixes to docs (#35780)
* Assorted set of fixes

* Cosmetic changes to lists

* Add more information related to connection throttling

* Changes to TOC

* Document return values

* More improvements

* Fix casing in title
7 years ago
tterranigma 3371a93b9e Adds doc for new slice filter (#35904)
* Adds doc for new slice filter

* Fixes example

* Adds empty line

* Moves documentation to other section and removes bad suggestion
7 years ago
Brian Coca 07221d777a
Better document connection: local (#34462)
* Better document connection: local

* Attempt at clear wording.

* Fixed spacing
7 years ago
Brian Coca 297eab5073 move away from bad inline var defs
partial fix for #35714
7 years ago