Commit Graph

24 Commits (e55565e951d5086cb787c01a751761374e4d48a6)

Author SHA1 Message Date
Alicia Cozine 4e5c13e075
Backport/2.9/docs (#63247)
* add more anchors to collections docs (#62827)

(cherry picked from commit 7e01de96d7)

* add anchors to support galaxy links (#62808)

(cherry picked from commit 1b3bf33bdf)

* doc: fix typos (#62852)

(cherry picked from commit b33ae14949)

* Add some documentation about using plugins in collections (#62465)
- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching

(cherry picked from commit d41050b28b)

* Remove Latin phrases from the docs (#62419)
* add styleguide about avoiding use of latin words

(cherry picked from commit e7436e278f)

* ovirt: Fixing typo in ovirt_disk examples (#62962)

(cherry picked from commit 50dc41cca2)

* vmware guidlines: adjust the location of cloud-config-vcenter.ini.template (#62970)

Update the location of the cloud-config-vcenter.ini.template template.
The file has been moved by: 2e7d36a3f9.

(cherry picked from commit 7ecfa4a471)

* Prefer https:// links in the docs site (#62939)

This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.

(cherry picked from commit c8315bfd60)

* fix minor typos (#62950)

(cherry picked from commit ad580a71c4)

* 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.

(cherry picked from commit 0d79013f51)

* add ios/iosxr deprecated modules (#62908)

(cherry picked from commit 6bbd9c9eca)
5 years ago
Jiri Tyr 31d6d7ada5 Updating developing_inventory.rst (#60647) 5 years ago
Alicia Cozine 3fc0694ffc removes last :doc: links in the dev guide (#58417) 6 years ago
ximon18 7474e39c37 Rewrote one awkward sentence. (#54892)
Rewrote awkward sentence in the developing inventory guide.

+label: docsite_pr
6 years ago
Sloane Hertel 9687879840
Fix inventory cache interface (#50446)
* Replace InventoryFileCacheModule with a better developer-interface

Use new interface for inventory plugins with backwards compatibility

Auto-update the backing cache-plugin if the cache has changed after parsing the inventory plugin

* Update CacheModules to use the config system and add a deprecation warning if they are being imported directly rather than using cache_loader

* Fix foreman inventory caching

* Add tests

* Add integration test to check that fact caching works normally with cache plugins using ansible.constants and inventory caching provides a helpful error for non-compatible cache plugins

* Add some developer documentation for inventory and cache plugins

* Add user documentation for inventory caching

* Add deprecation docs

* Apply suggestions from docs review

* Add changelog
6 years ago
Chris Gavin 43042682e8 Fix an incorrect function call in a documentation example. (#53233) 6 years ago
Divided by Zer0 1f06b3ca7d ungrouped as a list (#50593)
* update the developing_inventory docs to show ungrouped as a dict with a "children" key; avoid 
[WARNING]: Found both group and host with same name: ungrouped
6 years ago
Richard Diphoorn ad549e375a Changed 'Control Machine' to 'Control Node' (#51696)
* Changed 'Control Machine' to 'Control Node' in the documentation. Changing the term 'Control Machine' to 'Control Node', to be in line with the basic concepts here: https://docs.ansible.com/ansible/latest/network/getting_started/basic_concepts.html

Also for both entities; Control/Managed using the same common denominator 'Node' brings consistency.

* Updated reference links to new term.
6 years ago
branen 88029a73d6 Correct docsite typos: it's -> its (#50812) 6 years ago
Karolis Kalantojus b5162c7a47 Documentation fix for developing own plugin (#50547)
Seems like `self` is not necessary in the call args

+label: docsite_pr
6 years ago
Phuurl 29c96d20fb Corrects minor typos in the documentation (#49668)
Signed-off-by: Phuurl <chubble.10@icloud.com>
6 years ago
Sloane Hertel f3d5ebb355 add more consistent extension matching for inventory plugins (#46786)
* Add consistent extension matching for inventory plugins that support YAML configuration files

* Document extension matching expectations
6 years ago
Alicia Cozine 9a76441c02
rewrite of the developer guide, part 1 (#45179)
* rewrite of the developer guide, part 1
6 years ago
Andreas Olsson 00e5123e4c Update documentation based on 301 permanent redirects (#43675) 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
Brian Coca 475abc0af7
inventory plugin docs (#42022)
* inventory plugin docs
* added set options
* minor wording and formatting fixes
* changed headers to std as per #35520, also added to main readme
* unified inventory plugin devel, referenced from generic plugin dev
* fixed typos and update as per feedback
7 years ago
Rémy Léone d639d5dc96 Fix typo (#38652)
Typo
+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
Joshua Smith 0c012703c1 Update developing inventory script docs. (#35639)
* Update developing inventory script docs.

* Copy edit.
7 years ago
Matt Martz 89c3151167 Give example of empty _meta in dyanmic inventory (#24085) 8 years ago
Adam Johnson f1c4b434cd Tidy example inventories in "Developing Dynamic Inventory Sources" (#18758)
Thanks @adamchainz!
8 years ago
Robin Schneider 3700bcb6dd Use HTTPS instead of legacy HTTP for ansible.com (#16870)
Mechanical edit done by this "one-liner":

```Shell
git ls-files -z "$(git rev-parse --show-toplevel)" | xargs --null -I '{}' find '{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#http://(www\.|galaxy\.|)ansible\.com#https://\1ansible.com#g;'
```

Related to: https://github.com/ansible/ansible/issues/16869
8 years ago
John R Barker 7df31aaca1 Fix all RST errors for docs/docsite/rst (#20005)
* developing_modules.rst is now in dev_guide, sync changes and delete the old version
* Cleaner RST & formatted code
* Tidyup roadmaps
* Link to repomerge
* Pull in abadger's fixes From https://github.com/ansible/ansible/compare/docs-code-block-fixes?expand=1
* Clean docsite/rst (apart from ROADMAP
8 years ago
Brian Coca 57f8b791d6 consolidated docs
point to new doc locations
removed non existing dirs
8 years ago