Commit Graph

141 Commits (2f531d73dd50f7524bd5636d4f68c780ec823e7a)

Author SHA1 Message Date
Andreas Olsson 0d79013f51 Modernize Vagrant documentation (#62923)
* By requiring a slightly newer Vagrant version (from 2015) we get the
  same generated Ansible inventory format is still used by today's
  version of Vagrant. That extended inventory format also has the
  benefit of allowing for simpler Ansible examples.

* Switching to a current and supported Ubuntu LTS version.
5 years ago
Michael Prokop b33ae14949 doc: fix typos (#62852) 5 years ago
Felix Fontein c3b1a0a7e8 Vultr: rename _facts -> _info (#61239) 5 years ago
Dustin Miller 20ced48717 Update link to user data knowledge base (#60991)
Removes old broken link, replaces with with updated and confirmed working link
5 years ago
Marek Anderson 3a919d4bec Doc - editorial for correct acronym introduction (#58519)
Introduce acronym GCP on first use. Introduce GCE acronym at all.
5 years ago
Gonéri Le Bouder 2401154fc4 VMware: rename VMWare to VMware (#58535)
Follow the nomenclature convention decided in https://github.com/ansible/ansible/pull/56814
5 years ago
Nabeel Al-Saber 7afdf11456 Add Oracle scenario guide (#58443)
* Create and update docs/docsite/rst/scenario_guides/guide_oracle.rst
5 years ago
Alicia Cozine 44b6f2ff56 removes last :doc: links in other sections of the docs (#58432)
* removes last :doc: links in other sections of the docs

* fix references to playbooks intro page
5 years ago
Sandra McCann 5569135efd create scenario guide template file (#58212)
* create scenario guide template file

* Apply suggestions from code review

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
5 years ago
Abhijeet Kasurde 5162d21ea3 VMware: vSphere Automation SDK installation docs (#57280)
* VMware: adds instructions for installing vSphere Automation SDK to the dynamic inventory scenario
6 years ago
Seth Hochberg 66bfa27685 Replace deprecated ansible-container references (#56427)
Link to ansible-bender instead of the deprecated ansible-container.

Co-Authored-By: Felix Fontein <felix@fontein.de>
6 years ago
Isaac 85fa65e5f0 docs: Update scopes value example (#56362)
Existing example in GCE guide returns "invalid scope" error; value needs "https://" prefix
6 years ago
stroebitzer dae5564e2b Fix var naming (#55796)
* Fix var naming in GCE guide
6 years ago
stroebitzer 943f7334c5 Fix var naming (#55795)
Make vars match tasks in Google Compute guide.
6 years ago
Alicia Cozine bb5059f2c7
Add security group info and example to AWS guide (#55783)
* expand documentation on how to use lookup plugin aws_service_ip_ranges with ec2_group module

* fix rst syntax error
6 years ago
Alex Stephen 91a664a93e Gce migration docs (#51838)
* migration docs for gce, with example playbook

* Update docs/docsite/rst/scenario_guides/guide_gce.rst

Co-Authored-By: rambleraptor <alexstephen@google.com>
6 years ago
Keith Maxwell 04220478da Fewer examples use connection: local in docs (#55133)
* Fewer connection: local lines in module examples and scenario guides

The line 'connection: local' is not required. See
./docs/docsite/rst/inventory/implicit_localhost.rst
6 years ago
ubruns 301d561420 Update guide_azure.rst (#54401)
* Update guide_azure.rst

Added a note to the 'Storing in a file' section, that the secret value of the ini file should be UrlEncoded.
Otherwise the user might get login errors (depends on the characters used in the secret).
6 years ago
Alicia Cozine a4d0bc2c43
Shortens Scenario Guides, incorporates vmware guide (#54554)
* Shortens Scenario Guides, incorporates vmware guide

* adds links from network scenario guides to other network docs
6 years ago
Derrick Johnson 62d3ed0e2f ACI Private_Key String to Allow for Vaulting (#54251)
* Allows the use of Private_Keys to be entered as a string instead of just a file. Making it possible to use VAULT to encrypt the key

* Fixed Issues auto check found

* Provide helpful information while avoiding credential exposure

* Restore original variable name :-)

* Fix a few other things

* Influence the default certificate_name in both cases

* Update documentation

* Add contributed docs

* Fix CI issue
6 years ago
Felix Fontein 8d62794f91 docker: rename docker_*_facts -> docker_*_info (#54124)
* Rename docker_*_facts -> docker_*_info.

* Add changelog.

* Update scenario guide.
6 years ago
James Cassell 953058d025 standardize connection variable names (#51776)
* standardize user/password connection vars

* docs: use ansible_user and ansible_password

* docs: var precedence for connection vars

* docs: ansible_become_pass -> ansible_become_password etc
6 years ago
Felix Fontein f6122fb63b Fix docs syntax highlighting errors (#50836)
* Add support for [WARNING]: ...

* Fix unreachable/failed output lexing.

* Detecting retry/--limit lines.

* Removing strange (invisible) characters which cause lexing problems.

* Using better-fitting lexers.

* Improve YAML lexing: don't accept quotes in keys.

* Add Django lexer (unchanged) from Pygments.

* Add support for != and % operators.
6 years ago
Dag Wieers 2798d5bafc
Clarify gather_facts and highlight important lines
Clarify gather_facts and highlight important lines

+label: docsite_pr
6 years ago
Felix Fontein d2c4f57f16 docker_service: rename to docker_compose. (#51035)
* Rename docker_service -> docker_compose.

* Added changelog.

* Update scenario guide.

* Clean up module.
6 years ago
Alan Rominger baf59ccaac Put in documented default for gcp_compute filters (#50025) 6 years ago
René Moser 48ffe2f3b2
tests: vultr: convert legacy tests to targets (#50156) 6 years ago
Abhijeet Kasurde ae404d1476 gcp: documentation update (#50183)
* gcp: documentation update

* Update example about dynamic inventory
* minor typo fixes in gcp_utils
* Additional information about enabling inventory plugin in ansible.cfg

partially fixes: #44404

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Abhijeet Kasurde ff49bbd15d Misc documentation update (#50190)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Jon Pugh e2b39a0607 Change the Packet.net section to be more consistent with the other *Cloud Guide pages. (#50170)
<!--- Your description here -->

+label: docsite_pr
6 years ago
Kevin Breit a9d68f3d52 Meraki scenario guide - describe how to merge new data with old data (#48999)
* Described how to merge new data with old data in the Meraki guide
Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
6 years ago
johnstudarus 679b7dce63 Update guide_packet.rst (#49007)
Properly parses the returned data to get the device data and IP address. 


+label: docsite_pr
6 years ago
Yunge Zhu d3b52d2a72 fix xxx.com (#48972) 6 years ago
Michael Scherer 2ca7279cae Correct the variable name in example (#48603)
Changed from 'ansilbe_python_interpreter' to 'ansible_python_interpreter'
6 years ago
Rémy Léone f4fa3314c4 Add support for Scaleway object storage (#46353) 6 years ago
Aren 6243f36319 gcp additional info & edit (#45986)
* There were 2 introduction headings

line 36 was a duplicate 'introduction' heading, and the section is more of a requisites description.

+label: docsite_pr

* edit for line 32+33 & 45>50 added
6 years ago
He Guimin 85ba30a3db Add new module ali_instance (#36898) 6 years ago
Bianca Henderson e52761fbd3 Making minor changes (#47311)
<!--- Your description here -->

+label: docsite_pr
6 years ago
Jon Stevens 0272fd4b37 docs: Fix restructuredtext link format (#47199)
Fix two links on guide_online.rst
6 years ago
Page Bowers 1ec71e503e Update the document to link to the script itself (#46986)
Added a link to the dynamic inventory script to make it easier for a user to find.
6 years ago
Artur Juraszek c0de93310f Mention YAML as a AWS CloudFormation template language (#46345) 6 years ago
Kevin Breit a690917b5f Meraki scenario guide - Changed section markup types (#46158)
* Changed section markup types, small fixes for style
- Add dashes per style guide
- Add TOC in case this grows
6 years ago
Rémy Léone 1d4d49369e Add a guide for Scaleway (#44810) 6 years ago
Sandra McCann df3655968f Infoblox scenario guide (#45664)
* creates infoblox scenario guide
* adds link to infoblox guide from modules
* adds WAPI to prerequisites
6 years ago
Rémy Léone d3d1ff7990 Add a guide for using Online with Ansible (#45277) 6 years ago
Dag Wieers e038338e9f Improvements to structure 6 years ago
Kevin Breit 3b38bf377e meraki - Remove YAML formatting on JSON code block (#45526)
* Remove YAML formatting on JSON code block
6 years ago
Alicia Cozine 4264be2b18 Remove more docs build errors (#45364)
* orphans testing pages to avoid not-in-toctree errors

* orphans various pages pending reorg

* adds module_utils and special_vars to main TOC

* uses a glob for scenario_guide TOC

* normalize and Sentence-case headings on community pages, typos

* re-orgs community TOC, adds all pages to toctree

* removes scenario guides index page

* adds style guide to community index

* basic update to style guide

* fix typo that created a new error

* removes not-in-toctree from ignore errors list

* leave removing files for future cleanup task
6 years ago
Kevin Breit ec3ce1f39c Meraki scenario guide (#41827)
* Initial commit for the Meraki scenario guide

* Added Meraki guide to indexes, fixed an error

* Added common parameters to scenario guide

* Add additional information for first draft
- Added very common parameters everyone uses.
- Documented common format for returned data from Meraki.
- High level explanation of error handling.

* Fix .rst formatting error

* Added section about handling returned data. More to come.

* Small formatting changes
6 years ago
Markus Suonto 0d81386144 Add single quotes around package name (#45152)
<!--- Your description here -->
`pip install ansible[azure]` results in `zsh: no matches found: ansible[azure]` at least in my computer (zsh on Ubuntu). I don't know if it is the case with all shells, but at least for me it is. Since square brackets `[]` are special characters in bash, I propose adding single quotes to make sure that package name is always interpreted as literal. The same error is also resolvable by setting noglob.
6 years ago
Yanis Guenane 857a553fa1 Vultr: Create the Vultr Guide (#44515) 6 years ago
Dag Wieers ac3781d40b Fix broken CI (#44937)
* Fix document structure

* Fix broken CI
6 years ago
Dag Wieers 32fc6746d8
Fix document structure (#44935) 6 years ago
Felix Fontein 376dcb9f84 docker scenario guide: docker-py -> docker (#44856)
* Don't install docker-py by default, but the more modern docker library.

* Addressing the review comments.
6 years ago
Brian Coca 893d59fabe
updated guides to avoid connection: local (#44227)
- want they really need is `delegate_to: localhost`
 - also reduced 'local_action' usage in favor of same
6 years ago
Ihor Dvoretskyi 5d5782ce9d Fixed links to the CLI clients (#35792)
CLI clients link is incorrect, fixed.
6 years ago
Dag Wieers cc2164f92a
ACI: Add specific info about running locally (#43903)
Since the ACI modules (like most network-related modules) run on the
local controller, this PR adds the necessary details so users are aware
of this particular feature.
6 years ago
sirkubax 07375be490 Fix docs errors (#33704) 6 years ago
♫ Christian Krause ♫ d779eb1f15 doc: fixes the the repetitions (#43937)
Wow, this does not seem to be an uncommon misspelling. Might be there
are some left that span over two lines. I noticed the one in the git
module and then used `grep -rw 'the the'` to find some more.
6 years ago
Andreas Olsson 00e5123e4c Update documentation based on 301 permanent redirects (#43675) 6 years ago
Etienne Deneuve 379fb87b44 add group_by_os_family in azure dynamic inventory (#40702) 6 years ago
Andreas Olsson 1a11cecaef Prefer https:// links in the docs site
All the changed urls are availible by way of https://. Most of them
already redirect.
6 years ago
Alicia Cozine 5fa8747af3 fixes broken link (#43458) 6 years ago
Abhijeet Kasurde d1c0b7a597 VMware: restructure docs (#43065)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Yanis Guenane d94cc3568a CloudStack: Fix typos in the Guide (#43303) 6 years ago
Alex Stephen 2916adc88a New doc guide for GCP (#41753)
* New doc guide for GCP

* Changes per PR

* Addressing PR comments on GCE scenario guide
6 years ago
Dag Wieers 75c8d8bfc2
Fix aci_tenant module references
<!--- Your description here -->

+label: docsite_pr
6 years ago
John R Barker e9dbebfa57
Fix some broken links (#42079)
* Fix some broken links

* We now only serve via https
* redirects don't work with anchors, so update those links (devel/dev_guide)
6 years ago
Troy Murray 15ce7c5bab change OS X to macOS (#41294)
* change OS X to macOS

<!--- Your description here -->

+label: docsite_pr

* Update all Mac OS X references to be macOS

* Drop extra Mac
6 years ago
Jon Dufresne bf304832ff Prefer readthedocs.io instead of readthedocs.org for doc links (#41537)
Read the Docs moved hosting to readthedocs.io instead of
readthedocs.org. Fix all links in the project.

For additional details, see:

https://blog.readthedocs.com/securing-subdomains/

> Starting today, Read the Docs will start hosting projects from
> subdomains on the domain readthedocs.io, instead of on
> readthedocs.org. This change addresses some security concerns around
> site cookies while hosting user generated data on the same domain as
> our dashboard.
6 years ago
Jon Dufresne dc7e50fa90 Update additional pypi.python.org URLs to pypi.org (#41373)
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
6 years ago
wazzaz 91803c6ad3 Format fix on VMware Guide (#41272)
* Updating format of VMware Guide: small formatting error - hyperlink to module
7 years ago
Yunge Zhu 21ea92feca Fixes #36621, support adfs auth through adal (#37909)
* update username/password auth to use adal lib

* remove default client_id after discussion

* fix lint error: trailing whitespace
7 years ago
Alicia Cozine 8f83061e70 corrects links to 'list_of' pages (#39161) 7 years ago
Matt Clay c262dbfd30 Use https for links to ansible.com domains. 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
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 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
Dag Wieers 70d49f7616
Fix indentation issue
<!--- Your description here -->

+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 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
Matt Clay 3937082892 Fix rst link syntax. 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 97fde8c760
ACI: Asorted fixes to documentation (#36681) 7 years ago
Dag Wieers fde4cc6219
guide_aci: Fix a few references (#36666) 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
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
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
scottb 1f609f8be3
Cleaned up some scenario guide titles and TOC placement. (#36225) 7 years ago
scottb c5dd0d97af
Relocate ACI guide and add to TOC (#36208) 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