Commit graph

643 commits

Author SHA1 Message Date
Toshio Kuratomi
e60c4d4690 Removes modules from TOC, speeding up build time and reducing doc disk space requirements. (#38428)
(cherry picked from commit 62c2b9a544)
2018-04-06 15:12:05 -07:00
Toshio Kuratomi
32a99acc88 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.

(cherry picked from commit f1b63f435e)
2018-04-06 12:44:52 -07:00
Alicia Cozine
222c1f1090 DOCS: Network Best Practices fixes (#38293) (#38360)
* fixes typo per #38217, corrects link anchor

* adds ssh-agent info per #35649

(cherry picked from commit 24fe8674a6)
2018-04-06 14:34:47 +01:00
Alicia Cozine
92562a2ba9 demonstrates best practices for group vars (#37930) (#38287)
* demonstrates best practices for group vars

* removes vm-specific var from example

* adds brackets to all [group:vars] refs

(cherry picked from commit 380c074808)
2018-04-05 13:17:44 +01:00
scottb
f629825299 Adds VMWare to TOC; sort scenario guides alphabetically (#38238) 2018-04-03 13:44:10 -07:00
Sam Doran
f1a060743a Doc build warning/broken link clean-a-palooza (#37382) (#38185)
* 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

(cherry picked from commit 381359a8f8)
2018-04-02 11:53:24 -07:00
Alicia Cozine
617d156eac revises network portion of 2.5 porting guide (#37938)
* revises network portion of 2.5 porting guide
(cherry picked from commit b72960fdd4)
2018-03-28 08:27:44 -07:00
Robert de Bock
2f8a851b44 Update porting_guide_2.5.rst
A fix to a minor typo. ("Previouslu" -> "Previously")

 label: docsite_pr
(cherry picked from commit 0cf2ecbc62)
2018-03-15 17:55:35 -07:00
Toshio Kuratomi
24d98f9e70 Porting guide (#37226) (#37228)
* Add the lookup plugin strictness to the porting guide

* Edited for clarity.

* Wordsmithing.

(cherry picked from commit fafcb3452f)
2018-03-08 16:06:34 -08:00
John R Barker
4df0be4b1b stable-2.5 docs in sync with devel (#37214) 2018-03-08 12:04:16 -08:00
John R Barker
e6effb32b8
Update developing_api.rst (#37108) (#37178)
Fix for #17716 and #36110
(cherry picked from commit 19f92005b9)
2018-03-08 10:54:29 +00:00
John R Barker
c4cb7daa6b
Link to new network platform pages (#37057) (#37058)
Also fix a few broken links
(cherry picked from commit 7a4e270ae0)
2018-03-06 09:34:40 +00:00
John R Barker
9ac8aa3552
Ability to link to other pages from plugin docs (#37009) (#37014)
Support relative links
(cherry picked from commit 985f09270d)
2018-03-05 15:20:49 +00:00
John R Barker
801b5dcd04
[WIP] Backport/2.5/multiple docs (#36907)
Backport/2.5/multiple docs
2018-03-05 14:40:14 +00:00
John R Barker
617659a33c
Network Platform docs (#36814) (#36899)
* introduces platform docs

(cherry picked from commit 4f63123320)
2018-03-01 11:47:42 +00:00
John R Barker
bfbea05d26
Fix broken links (#36864) (#36866)
(cherry picked from commit 41c066eff9)
2018-02-28 15:56:45 +00:00
John R Barker
f14e0e7ee3
clarify the slicing example (#36842) (#36847)
As stated by fellow contributors, update the slicing example

Resolves:
Related: #36625
Signed-off-by: Daniel Andrei Minca <mandrei17@gmail.com>
(cherry picked from commit 8362ddd107)
2018-02-28 13:31:33 +00:00
John R Barker
409193a7dc
Explain what the Ansible Quickstart video does (#36453) (#36793)
* 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.

(cherry picked from commit de7692b1c9)
2018-02-27 18:48:13 +00:00
Matt Clay
78cc85fa27 Fix rst link syntax.
(cherry picked from commit 3937082892)
2018-02-26 11:18:38 -08:00
John R Barker
6bf30f65b9
Fix typos (#36671) (#36724)
Fix minor typos
(cherry picked from commit 487ff1fe9b)
2018-02-26 11:27:24 +00:00
John R Barker
3d1c8bc2e1 Network Getting started docs (#36337) (#36597)
* first draft of getting started guide
(cherry picked from commit 51a010a696)
2018-02-22 15:15:11 -08:00
John R Barker
3b1c90cd7c Depreciate aos (#36029) (#36393)
* Deprecate Apstra's aos_* modules

These modules don't work with AOS 2.1 or higher.
They will be replaced non-upstreamed modules
2018-02-19 19:30:12 -08:00
Ganesh Nalawade
51673f431f
Update network debug troubleshooting guide (#36288) (#36391)
* 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

(cherry picked from commit b57cc7cf31)
2018-02-19 21:17:54 +05:30
Brian Coca
57bccd10af updates to module testing (#36043)
* updates to module testing

gives those using internal modules an alternative

* Copy edit

(cherry picked from commit 3eff279dd7)
2018-02-16 13:19:28 -05:00
Brian Coca
3635961b1b updates to porting guide (#36219)
* updates to porting guide

(cherry picked from commit 7a6d6870d4633ae38a14cc799521b5fc1c0320fd)

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

* Fixed typo

(cherry picked from commit 1f363a6a7c)
2018-02-15 23:55:09 -08:00
scottb
92cb719a2d Relocate ACI guide and add to TOC (#36208)
(cherry picked from commit c5dd0d97af)
2018-02-15 23:43:12 -08:00
Patrick Fink
ba6a242f17 Fix typo in vars.rst (#35098)
(cherry picked from commit 43eb97ef92)
2018-02-15 23:36:53 -08:00
Dag Wieers
a3ae64440d 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
(cherry picked from commit a875363e35)
2018-02-15 23:35:03 -08:00
Dag Wieers
5a8313f3a2 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
(cherry picked from commit 218f008dab)
2018-02-15 23:34:25 -08:00
Dag Wieers
dd215eac0b 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

(cherry picked from commit 80e1e0b017)
2018-02-15 23:12:44 -08:00
Brian Coca
74b120329c never tags docs and test (#35964)
* fufilling the promise

* moved changes

* Copy edit

(cherry picked from commit 0cf70a8970)
2018-02-14 20:34:11 -05:00
David Newswanger
078467d18d 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

(cherry picked from commit 3f5caf659e)
2018-02-14 15:41:43 -08:00
scottb
d03202e4d6 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.

(cherry picked from commit c10080bfba)
2018-02-13 11:00:43 -08:00
scottb
8998ec17b8 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

(cherry picked from commit 373b1dcf59)
2018-02-13 11:00:31 -08:00
John R Barker
c76caf3c29
Consistant headings (#36112) (#36113)
(cherry picked from commit 480a9c10c9)
2018-02-13 14:48:59 +00:00
John R Barker
72ad157b07
Change wording of Going Further section (#35949) (#36032)
* 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.

(cherry picked from commit d5ae63c0ea)
2018-02-12 10:54:06 +00:00
John R Barker
67590e4e35
Test against a single transport (#35903) (#35970)
Network integration tests can use tags to run only a specific transport
(cherry picked from commit c3523cdd60)
2018-02-09 16:17:34 +00:00
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
2018-02-08 12:41:25 -05:00
Brian Coca
07221d777a
Better document connection: local (#34462)
* Better document connection: local

* Attempt at clear wording.

* Fixed spacing
2018-02-07 16:17:57 -05:00
Brian Coca
297eab5073 move away from bad inline var defs
partial fix for #35714
2018-02-07 16:17:01 -05:00
Martin Krizek
4319947e60
Remove jinja native types from roadmap (#35444) 2018-02-07 17:00:16 +01:00
Ganesh Nalawade
1d068d4af9 Update network section in 2.5 porting guide (#35643)
* Update 2.5 porting guide with network module_utils move
2018-02-06 15:35:59 -06:00
Dag Wieers
67c217398c
Add initial ACI guide (#35364)
* Add initial ACI guide

* Implement all review suggestions
2018-02-06 11:44:32 +01:00
Marc Mercer
6bd4803c80 Fixing syntax for mail callback doc (#35379) 2018-02-05 23:14:08 -08:00
Andrew Gaffney
e9b0a4ccb4 Add support for defining index var for task loops 2018-02-05 22:14:05 -05:00
Joshua Smith
cee5d420de Add examples for OpenBSD hosts. (#35691)
* Add examples for OpenBSD hosts.

* Incorporate changes recommended based on feedback from my pull request.
2018-02-05 18:21:45 -05:00
Tina Müller (tinita)
57d5b8642a Add examples to YAMLSyntax; fix minor issues and improve wording (#35703)
* Add examples to YAMLSyntax; fix minor issues and improve wording

I added proper titles to "Flow Collections" and "Block Scalars", because these
are official YAML Terms, so people can find better help when having issues.

I changed the "ignored newlines" to "folded newlines" because I think ignoring
gives a wrong impression, especially since empty lines (more than one newline)
are not ignored and have a special meaning.

I added an example how to enforce a newline in a folded block scalar.

I fixed the list of characters that are allowed/not allowed in plain and
double quoted scalars.

I added the #yaml channel to the IRC link.

I added links to the YAML Specs. For completeness, I also included YAML 1.2,
although PyYAML and libyaml currently implement 1.1.

* Improve wording

* Add three more characters to forbidden first characters
2018-02-05 13:32:06 -08:00
Matt Martz
975f4def78
Tags on includes only affect the include. FIxes #35729 (#35732) 2018-02-05 09:53:56 -06:00
Joshua Smith
5c2783c161 Update example syntax in playbooks_tests.rst. (#35688) 2018-02-05 14:14:15 +00:00
Joshua Smith
f1d0279921 Update example syntax in test_strategies.rst, (#35689) 2018-02-05 14:13:00 +00:00