Commit Graph

943 Commits (68b39f7a84b2db80ec68468f234a3a92cb30158c)

Author SHA1 Message Date
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