1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Commit graph

697 commits

Author SHA1 Message Date
scottb
e7f9c5cc60 Copy edits and tweaks 2018-03-02 18:14:07 -05:00
Brian Coca
cf43e0d605 updated api example
- added many more comments
- removed very obsolete 1.x refs
2018-03-02 18:14:07 -05:00
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
2018-02-28 16:01:18 -08:00
Russ Starr
4a6758b74f Update playbooks_filters_ipaddr.rst (#36883)
Fixed a typo since the example should be referencing the newly defined list.
2018-03-01 09:25:40 +10:00
Alicia Cozine
4f63123320
Network Platform docs (#36814)
* introduces platform docs
2018-02-28 15:16:32 -06:00
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.
2018-02-28 21:14:57 +00:00
John R Barker
41c066eff9
Fix broken links (#36864) 2018-02-28 15:54:58 +00:00
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>
2018-02-28 13:28:38 +00:00
John R Barker
3911b9c53a
typo 2018-02-28 12:41:16 +00:00
John R Barker
b3c64ecd09
khjh
j
2018-02-28 12:40:31 +00:00
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
2018-02-27 18:40:24 +00:00
Wolfgang Felbermeier
9c81b5d92b Fix table display width. (#36728) 2018-02-26 14:24:34 -08:00
Brian Coca
7a81d5f11e removed now irrelevant section
fixes #35760
2018-02-26 14:25:43 -05:00
Matt Clay
3937082892 Fix rst link syntax. 2018-02-26 11:17:43 -08:00
Kevin Breit
487ff1fe9b Fix typos (#36671)
Fix minor typos
2018-02-26 11:24:53 +00:00
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
2018-02-25 19:13:16 +01:00
Dag Wieers
97fde8c760
ACI: Asorted fixes to documentation (#36681) 2018-02-24 22:50:54 +01:00
Dag Wieers
e520ff2e99
docsite: Improve previous fix for smartphone/tablet (#36678) 2018-02-24 21:45:25 +01:00
Dag Wieers
5da948f792
Fix rendering docsite on smartphone/tablets (#36675) 2018-02-24 17:16:40 +01:00
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
2018-02-24 14:06:12 +01:00
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 !
2018-02-24 03:57:37 +01:00
Dag Wieers
fde4cc6219
guide_aci: Fix a few references (#36666) 2018-02-24 01:47:44 +01:00
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.
2018-02-24 00:38:50 +01:00
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
2018-02-23 17:10:47 -06:00
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
2018-02-23 09:51:36 -06:00
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>
2018-02-23 10:46:31 +00:00
Alicia Cozine
51a010a696 Network Getting started docs (#36337)
* first draft of getting started guide
2018-02-22 20:43:04 +00:00
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
2018-02-21 19:35:59 +01:00
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.
2018-02-20 12:12:12 -08:00
Matt Lee
75ab070c63 Update vault.rst (#36328)
hunter2 not hunter42. http://bash.org/?244321
2018-02-20 12:11:32 -08:00
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
2018-02-19 20:40:25 +05:30
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
2018-02-19 12:01:14 +01:00
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
2018-02-16 18:26:07 +00:00
Brian Coca
3eff279dd7 updates to module testing (#36043)
* updates to module testing

gives those using internal modules an alternative

* Copy edit
2018-02-16 10:04:10 -08:00
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
2018-02-15 23:54:45 -08:00
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
2018-02-15 20:34:40 +00:00
John R Barker
577ff4d949
Add stub porting_guide_2.6.rst (#36190)
* Add stub porting_guide_2.6.rst

* Typo fix
2018-02-15 07:29:15 +00:00
scottb
1f609f8be3
Cleaned up some scenario guide titles and TOC placement. (#36225) 2018-02-14 23:14:22 -08:00
scottb
391896ca9d
Fixed typo in link. (#36220) 2018-02-14 18:37:03 -08:00
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
2018-02-14 15:40:35 -08:00
Brian Coca
0cf70a8970
never tags docs and test (#35964)
* fufilling the promise

* moved changes

* Copy edit
2018-02-14 17:01:36 -05:00
scottb
c5dd0d97af
Relocate ACI guide and add to TOC (#36208) 2018-02-14 14:00:18 -08:00
scottb
dc902a5022
Fixes broken nested tables in module docs (#36144) 2018-02-13 15:21:10 -08:00
Brian Coca
28015d8ae9 ensure cli dir exists before saving files to it 2018-02-13 17:43:26 -05:00
Brian Coca
5a0f4f0646 removed gnerated files
@dharmabumstead, probably need a few more of these
2018-02-13 15:47:31 -05:00
Patrick Fink
43eb97ef92 Fix typo in vars.rst (#35098) 2018-02-13 15:05:11 -05:00
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.
2018-02-13 10:52:13 -08:00
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
2018-02-13 07:23:55 -08:00
John R Barker
480a9c10c9
Consistant headings (#36112) 2018-02-13 14:43:16 +00:00
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
2018-02-13 13:54:44 +01:00