Commit Graph
100 Commits
Author SHA1 Message Date
Alicia CozineandGitHub 2c67954f9b Docs: adds warning about utf-8 in templates (#75504) 2021-09-01 16:21:18 -04:00
e35e8ed2ec makes Fest link from docs trackable (#75594)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-08-27 15:51:57 -05:00
d652b19e11 Docs: clarify dir names for local plugins (#75157)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
2021-08-12 11:47:27 -04:00
Alicia CozineandGitHub 3c3e30a610 Docs: Add Matrix as a chat option (#75406) 2021-08-12 11:47:02 -04:00
d9d98740f2 new antsibull supports breadcrumbs toggle (#75424)
* new antsibull supports breadcrumbs toggle

* let antsibull versoin float free

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-08-06 21:21:32 +02:00
13c28664ae Docs: talk about AWX or the Platform, not Tower (#74952)
* updates Tower page to talk about RHAAP

* updates scenario guide Tower references

* updates Tower references to use AWX and/or RHAAP

* more scenario guides fixes

* fix CI failures

* Update docs/docsite/rst/porting_guides/porting_guide_2.8.rst

* removes tower link

* for 2.8, still mention Tower along with AWX and RHAAP

* aws guides should be updated in the collection, where they now exist

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-07-21 13:08:46 -04:00
Alicia CozineandGitHub 0e9d1ab1cc incorporate minimalism feedback on distributing collections page (#75266) 2021-07-21 13:05:14 -04:00
230c00e937 README optimizations (#75115)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-06-25 13:03:39 -04:00
Alicia CozineandGitHub 5d3d9ad8be docs: adds Ansible 5 roadmap (#75075) 2021-06-23 16:53:57 -04:00
Alicia CozineandGitHub 58f26388be Update docs requirements list (#74956)
* removes upper bound on sphinx version
* updates versions of docs build dependencies, adds known good requirements file
* adds instructions for using known_good_reqs file
2021-06-22 13:58:54 -05:00
Alicia CozineandGitHub a7be495b7b Update plugin docs (#75050)
* edit existing plugin pages, headings, and links
2021-06-21 16:07:18 -04:00
33924d7e8d gives each banner a unique div ID (#74907)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-06-03 16:51:31 -04:00
605b1a1c5c documents community 'extra docs' option in collections (#74886)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
2021-06-03 14:22:21 -04:00
f88e81a62c updates links in comments to point to current docs (#74834)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-06-03 14:00:24 -04:00
Alicia CozineandGitHub 62fc4ad8da adds banner for GalaxyNG survey (#74889) 2021-06-03 11:22:49 -04:00
b765d3799b update backporting instructions to reflect new latest stable branch, some edits (#74512)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-04-30 11:42:03 -04:00
9d9b08bece fix spacing to fix header, reorg contributing page (#74421)
Co-authored-by: John R Barker <john@johnrbarker.com>
2021-04-27 10:41:10 -04:00
Alicia CozineandGitHub c90922ee36 Docs - Split Developing collections page, add info on optional module_utils (#74105)
*
2021-04-23 17:03:46 -04:00
Alicia CozineandGitHub 126e9244c2 updates list of available versions for Ansible 3 (#74265)
* updates list of available versions for Ansible 3
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-04-13 16:59:36 -04:00
Alicia CozineandGitHub d7f826c987 Change look and feel of the ansible-core docs (#74200) 2021-04-12 16:39:13 -04:00
Alicia CozineandGitHub 05662fd2ab Docs: clarify role docs - vars vs params, dependencies (#74104) 2021-04-06 11:24:28 -04:00
Alicia CozineandGitHub c66cff444c documents the use of ansible.legacy (#73942) 2021-03-25 16:36:46 -04:00
eb631c1881 use present tense for porting guide entries (#74021)
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
2021-03-25 15:04:10 -04:00
Alicia CozineandGitHub 7a55e98d29 clarifies docs for file module, addresses issue 72372 (#73938) 2021-03-18 12:34:04 -07:00
30c465c1a9 Promote publication (#72400)
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
2021-03-17 16:14:32 -04:00
b57444af14 Rebased pr73824 (#73934)
Co-authored-by: Eugene <k.evgen61@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-03-17 16:07:38 -04:00
474f46ea56 Docs: Updates the release and maintenance page to reflect new cadences (#73781)
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
2021-03-11 14:25:18 -05:00
Alicia CozineandGitHub 31932f5fa3 Docs: Update installation page for package split (#73790) 2021-03-11 11:05:44 -08:00
29d3951464 Docs: Adds banner for core/package split (#73552)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-02-23 15:54:17 -05:00
1d8760779c left a stray </div> by mistake (#73132)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-01-06 12:13:24 -05:00
Alicia CozineandGitHub e5ccd18be4 Wording changes to docs (#70082) 2020-12-08 16:46:34 -05:00
91b0dfb659 adds changelog for already-merged PR (#71947)
* adds changelog for already-merged PR

* Update changelogs/71921-raise-bytes-for-binary-test

Co-authored-by: Matt Clay <matt@mystile.com>

* adds yaml extension, corrects placement

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Matt Clay <matt@mystile.com>
2020-09-25 14:14:17 -04:00
eed606e0e9 adds name lines to handler re-use examples (#71946)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-09-25 12:46:45 -04:00
27826827e9 updates intersphinx references for docs links (#71921)
* DOCS: updates intersphinx references for docs links
* TESTS: Raise the number of bytes scanned to determine if a file is binary. The newest ansible-2.10.inv file has its first null byte at position 2261. 4096 is still a cheap chunksize to read so it still makes sense to raise this.

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2020-09-25 10:33:29 -05:00
Alicia CozineandGitHub b430f9b9aa Adds FAQ and other pointers for collections (#71606) 2020-09-09 13:16:26 -04:00
Alicia CozineandGitHub 96aee766f4 More docs updates to reflect collections ecosystem (#71597) 2020-09-02 13:50:12 -04:00
Alicia CozineandGitHub b694dbadfe User guide overhaul, Table of Contents (#71553) 2020-09-01 12:29:21 -04:00
Alicia CozineandGitHub 29b20bd1b1 DOCS: Mentions ansible-base, adds collections pointers to Community and Dev Guides (#71480) 2020-09-01 12:25:37 -04:00
f82a1e06d7 updates network plugin docs pages for 2.10 (#71467)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-08-26 12:05:20 -04:00
5073cfc8bc incorporate minimalism feedback on debugging page (#71272)
Co-authored-by: bobjohnsrh <50667510+bobjohnsrh@users.noreply.github.com>
2020-08-18 14:16:36 -04:00
Alicia CozineandGitHub 02ea80f6d7 tidies up vars page (#71339) 2020-08-18 14:01:03 -04:00
ae3b8eec12 Adds fest link (#71241)
* adds two possible links to AnsibleFest - pick one

* selected preferred text

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-08-12 16:44:56 -04:00
8313cc8fb1 Warning banner should only show on /devel/ docs, not on pages with 'devel' in their titles (#70849)
* banner should not be placed on pages with 'devel' in their titles

* Update docs/docsite/_themes/sphinx_rtd_theme/ansible_banner.html

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* Only match paths at the beginning

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com>
2020-08-03 16:56:55 -04:00
4f4436c124 updates changelog types; some updates for easier translation (#71027)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
2020-08-03 13:46:41 -04:00
9879da8e23 DOCS: add 2.10 collections roadmap (#70975)
* draft of 2.10 collections roadmap

* incorporates feedback from felixfontein

* gundalow and samccann feedback, fix link

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-07-30 16:26:03 -04:00
b28d59124b WIP: add collections as an intersphinx link (#70826)
* adds collections as a ref for intersphinx

* no need for intersphinx

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-07-23 08:44:05 -07:00
Alicia CozineandGitHub db354c0300 Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
Alicia CozineandGitHub f1f782fc37 partial update of community docs to reflect collections transition (#70488) 2020-07-14 15:47:18 -04:00
c89f3cda9e incorporate minimalism feedback on filters page (#70366)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-07-01 16:15:32 -04:00
4a0f42923b adds japanese translation as a version-switcher option (#70214)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-06-22 16:25:44 -04:00
923655642b mentions minimum required boto versions (#68124)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-06-16 12:32:44 -04:00
851e8e18b2 clarifies that vars can begin with _, with a warning (#69749)
Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com>

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com>
2020-06-11 14:16:41 -04:00
f509a22f9d add changelog categories, update CVE fragments to use security_fix category (#69968)
* use security_fix category in changelogs for CVEs

* these fragments do not say CVE but are security fixes

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-06-11 10:24:01 -07:00
d7c03e9fdb Update testing collections to mention ansible-base versions (#69805)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-06-10 16:22:01 -04:00
6fffb0607b WIP: Docs: User guide overhaul, part 4 (#69266)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-05-15 16:18:07 -04:00
9139c1f81d consistently call tests tests, not filters (#68170)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-03-25 21:31:29 -04:00
69543b47c9 fix last 7 docs errors on post-migration test runs (#68115)
* address toc-tree-glob-pattern-no-match errors

* address Include-file-not-found error

* address 2.10 porting guide errors, add warning to page

* updates individual plugin type pages

* Add ignores.

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Matt Clay <matt@mystile.com>
2020-03-23 11:14:21 -05:00
4e8b240b8b Intersphinx (#68090)
* try to route 2.9 porting guide links to 2.9 module docs

* refreshed existing .inv files

* better URL

* new .inv file for version-specific links

* adds targets for version-specific docs

* fixes 2.5 porting guide refs

* fixes 2.8 porting guide refs

* fixes 2.7 porting guide refs

* fixes links on ACI guide

* adds .inv files for versions 2.5 through 2.8

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-03-06 14:16:35 -08:00
Alicia CozineandGitHub 75191c1484 fixes link, makes intrapage TOC local (#67664) 2020-02-24 14:29:22 -05:00
cb8ce7159d Docs: clarify that roles do not inherit collections set in a playbook (#66667)
Co-authored-by: Matt Davis <nitzmahone@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-01-22 15:08:38 -05:00
Alicia CozineandSandra McCann 0b503f6057 Docs: User Guide overhaul, part 3 (#66371) 2020-01-21 16:57:55 -05:00
40fb46f1e8 fixes import paths for ansible unit testing (#65775)
* fixes import paths for ansible unit testing

* Update docs/docsite/rst/dev_guide/testing_units_modules.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-12-16 11:07:26 -06:00
Alicia CozineandSandra McCann 860cacc54f Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
Alicia CozineandSandra McCann b0c8e7926f link from quickstart page to Network Getting Started (#65150) 2019-11-21 11:42:57 -05:00
Alicia CozineandSandra McCann 1df62f129a Collections versions (#64912) 2019-11-18 09:31:29 -05:00
Alicia CozineandSandra McCann ac9c75d467 updates RHEL packages to 2.9 (#64532) 2019-11-06 14:33:17 -05:00
Alicia CozineandSandra McCann 6e07d4c1d9 add general facts-to-info paragraph (#64293) 2019-11-01 16:09:03 -04:00
Alicia CozineandSandra McCann 941a9b68fc Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
Alicia CozineandSandra McCann d3ec5ca80f Update pip module docs (#62359)
* Clarifying pip module requirements in reference to #47361

* Further clarifying message with link to ansible_python_interpreter

* Clarifies pip behavior

* incorporates review feedback
2019-09-17 16:30:51 -04:00
Alicia CozineandSandra McCann 0e1ec04efb roadmap should reflect upstream release, not downstream (#61611) 2019-08-30 13:07:24 -04:00
Alicia CozineandJordan Borean a6f585eb62 remove the word "support" from Windows pages, add Windows Server 2019 (#61404)
* remove support from Windows pages, add Windows Server 2019

* jborean feedback

* Removed CBT info

Removed the CBT note about what transports Ansible actually supports. We've worked with both NTLM and Kerberos for a while now.
2019-08-28 08:05:12 +10:00
Alicia CozineandSandra McCann 6ad40fd6b8 removes the word 'support' from appendix pages (#61409) 2019-08-27 17:11:53 -04:00
Alicia CozineandSandra McCann e5e3486be6 clarifies how ASK works for Tower credentials (#59050)
* clarifies how ASK works for credentials
2019-07-16 15:37:47 -04:00
Alicia CozineandSandra McCann 0dd3fb82eb get rid of Sphinx 2.1.2 errors (#59001) 2019-07-12 16:19:08 -04:00
Alicia CozineandSandra McCann fec314febb clarifies nmcli option 'conn_name' (#59034) 2019-07-12 16:07:55 -04:00
Alicia CozineandSandra McCann 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
2019-06-27 12:18:17 -04:00
Alicia CozineandSandra McCann d4f0bc183e removes last :doc: links in user guide (#58433)
* removes last :doc: links in user guide
2019-06-26 17:07:27 -04:00
Alicia CozineandSandra McCann 3fc0694ffc removes last :doc: links in the dev guide (#58417) 2019-06-26 14:59:33 -04:00
Alicia CozineandSandra McCann 158f97bfb2 updates docs reqs to specify Pygments version, remove tornado (#58007) 2019-06-18 14:24:57 -04:00
Alicia CozineandSandra McCann 8dfa376e1c removes link from 404 content, explains options (#57971) 2019-06-18 09:25:12 -04:00
Alicia CozineandSandra McCann e834cd7d41 updates reqs for building docs locally (#57967) 2019-06-17 15:32:01 -04:00
Alicia CozineandGitHub 5658b2ee3e Adds custom 404 with cowsay image (#57422)
* Adds custom 404 with image, updates CI reqs, sets version latest for TOC links on 404 page
2019-06-17 10:47:54 -05:00
Alicia CozineandGitHub fc94d79c47 CLI docs include license not copyright (#56871) 2019-05-23 14:53:07 -05:00
Alicia CozineandGitHub f88b660717 adds 2.9 roadmap, reversed local TOC order (#56371) 2019-05-16 09:28:33 -05:00
Alicia CozineandGitHub 118cf3ece6 Cloud dev docs to rst (#56485)
* Moves developer docs for AWS, ovirt, and openstack modules out of lib/ansible/, integrates them with dev_guide, with abadger's fix to make python snippets pass rstcheck
2019-05-16 09:05:12 -05:00
Alicia CozineandGitHub 7636f36a8a gcp_compute_target_proxy does not exist, update deprecated redirect (#56496) 2019-05-15 21:08:58 -05:00
Alicia CozineandSandra McCann 3c8d8b1509 should have gone into 52373 (#56306) 2019-05-10 10:59:50 -04:00
Alicia CozineandSandra McCann 8cb76408d3 Update include_role description (#56001)
* Update include_role description to discuss tasks: use

The previous description in this statement's description really threw me off, and is IMO ambiguous at best. 'Loads and executes a role as a task dynamically. This frees roles from the roles: directive and allows them to be treated more as tasks.'

For reference, I spent a long time trying to make include_role, with a loop, work under a roles: section. It doesn't work, but this documentation and its use of the roles: keyword in the opening, and the phrase '"more" as a task' muddies the waters.

+label: docsite_pr
2019-05-06 16:17:50 -04:00
Alicia CozineandGitHub 8542459b95 Docs: edits & expands module_utils & search path info in dev guide (#55931)
* Update docs/docsite/rst/dev_guide/developing_module_utilities.rst
2019-05-01 07:52:34 -05:00
Alicia CozineandGitHub 5439eb8bd8 Clarifies how Ansible processes multiple failed_when conditions (#55941)
Docs: Clarify that multiple failed_when conditions join with AND not OR to counter third-party pages online incorrectly stating that it uses `OR`. ([example](https://groups.google.com/d/msg/ansible-project/cIaQTmY3ZLE/c5w8rlmdHWIJ)).
2019-05-01 07:31:59 -05:00
Alicia CozineandGitHub 9d5b5d7ddd correct description of modules vs plugins (#55784) 2019-04-26 09:32:42 -05:00
Alicia CozineandGitHub 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
2019-04-26 09:31:49 -05:00
Alicia CozineandSandra McCann d7f6493084 adds better links to tips and pitfalls page (#55458) 2019-04-17 14:30:34 -04:00
Alicia CozineandGitHub 32218332ee Add a recurse example to file module docs (#54926)
Add recurse example to file module
must set state: directory to use recurse: yes
2019-04-05 16:24:29 -05:00
Alicia CozineandGitHub a4d0bc2c43 Shortens Scenario Guides, incorporates vmware guide (#54554)
* Shortens Scenario Guides, incorporates vmware guide

* adds links from network scenario guides to other network docs
2019-04-04 11:58:30 -05:00
Alicia CozineandSandra McCann a361140680 Update the Loop docs (#47895)
* first review of loops page

* round two

* round three

* puts 'not deprecating' message in a note

* fixes note syntax

* clarifies loop_control sections

* loops require list input

* incorporates bcoca and sivel feedback

* fixes links

* more bcoca feedback

* adds examples to loop update guidelines

* adds explicit code-blocks

* remove stray copypasta
2019-02-26 10:40:13 -05:00
Alicia Cozineandansibot d84e21dfc8 fix docs for tower modules (#50710) 2019-01-09 09:21:26 -05:00
Alicia CozineandSandra McCann 4d6807a6b0 uses correct highlighting (#50457) 2019-01-02 13:28:35 -05:00
Alicia CozineandSandra McCann 6fc4bb4a6d Command module docs: args vs argv (#49907)
* add note about 'args', update examples
* Update lib/ansible/modules/commands/command.py

Co-Authored-By: acozine <879121+acozine@users.noreply.github.com>
2018-12-19 13:30:05 -05:00
Alicia CozineandGitHub 90a6771bc8 removes space from example of L(link) syntax (#49908) 2018-12-14 09:15:57 -06:00