scottb
0c0dc8d9fc
Adds documentation structure and stubs for new VMWare guide ( #39246 )
...
* Adding initial skeleton of VMWare docs
* Updated product name capitaliztion; ready for initial PR.
* Add few files and updated some links
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
* Fixed duplicate anchor tag
7 years ago
Toshio Kuratomi
1885883a88
Document follow changes
...
Add the file, blockinfile, and replace changes to the follow parameter
to the porting guide
7 years ago
Anna Liao
c812396793
Update playbooks_variables.rst ( #39570 )
...
<!--- Your description here -->
+label: docsite_pr
7 years ago
Abhijeet Kasurde
85ad2eae8a
Fix typo in porting guides index page ( #39582 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Matt Clay
054efb8d80
Update 2.6 roadmap dates. ( #39573 )
7 years ago
Andrew Gaffney
4134f1204b
Add Andrew Gaffney to list of people in Committers Guidelines doc
7 years ago
Brian Coca
19fee0ef41
fix keyword doc generation
...
* use aliases when they exist
* fix hardcoded loop attributes handling
7 years ago
Andrius Benokraitis
9773157da6
Update intermediate_concepts.rst ( #39500 )
...
Updated GitHub Repos section to better explain what ansible-network@redhat.com is for (not an email list, but adding to the network-automation github repo.
7 years ago
Alicia Cozine
c8a9b411bc
Last docs link fixes ( #39391 )
...
* should not need <>, but fails without
* adds anchor to keywords page, uses it on plugins pages
* fixes envvar link errors
* harmonize file name and ref name as python_3
* removes undefined-lable from ignore list
7 years ago
Abhijeet Kasurde
9f1254a32f
Typo fix in testing link ( #39407 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Matt Clay
32d786af65
Convert more http links to https.
7 years ago
Lucid One
40fcef3e41
Adding support for opensearch of documentation ( #38593 )
7 years ago
Jordan Borean
f8853d83e3
windows: removed deprecated features in 2.6 ( #38930 )
...
* windows: removed deprecated features in 2.6
* Comma surgery.
7 years ago
Alicia Cozine
4b52a54e18
Reduce warnings ( #39254 )
...
* removes FAQ links; no entries exist for linked config settings
* fixes various anchors and links
* addresses abadger comments, thanks
* marks orphan pages, avoids TOC errors
* adds links for remote_tmp setting to FAQ
7 years ago
Matt Martz
476d1f818e
Documentation for query/q. Fixes #38275 ( #38558 )
7 years ago
Matt Clay
7975c8fab0
Improve integration-aliases docs. ( #39087 )
7 years ago
Brian Coca
b533ebe20d
remove slice docs ( #37946 )
7 years ago
Andrius Benokraitis
7881866db4
Update ROADMAP_2_6.rst with additional network roadmap items ( #39225 )
...
* Update ROADMAP_2_6.rst
Added network_get and network_put to Network modules roadmap
* Update ROADMAP_2_6.rst
add netconf_config to the network module roadmap
7 years ago
Alicia Cozine
8f83061e70
corrects links to 'list_of' pages ( #39161 )
7 years ago
Alicia Cozine
becc2a0347
adds index page for roadmaps to support internal links ( #39109 )
...
* adds index page for roadmaps to support internal links
* includes only roadmaps index page in TOC
7 years ago
Alicia Cozine
0fef3f1b48
avoids not-in-toc errors with :orphan:
7 years ago
Matt Clay
c262dbfd30
Use https for links to ansible.com domains.
7 years ago
saichint
6eecbf10e6
fix nxos_igmp_interface issues ( #38752 )
...
* fix nxos_igmp_interface issues
* shippable fix
* fix oif_prefix and oif_source
* shippable fix
* shippable fix
* shippable fix
* add an example for oif_ps
* review comments
* review comments
* more review comments
* fix typo
7 years ago
Josh
aa9d7cb1f3
Update playbooks_debugger.rst ( #39117 )
...
Minor typo correction
+label: docsite_pr
7 years ago
Benn Roth
56967497d5
minor accuracy fix
...
Don't round the parameter 12.04 in the explanatory paragraph unless `version()` rounds the parameter
(cherry picked from commit 5cf544e03e
)
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
John R Barker
c4e298b808
Correct to development_process ( #39069 )
7 years ago
John R Barker
ebdf6d0fab
Add missing > to fix 'edit this document' link ( #39067 )
7 years ago
Salvatore Mesoraca
aaf2ff629d
Fix formatting error in rst plugin template ( #38956 )
...
The hyperlink syntax used is wrong and the resulting
rendered documents have broken links.
7 years ago
Matt Clay
9e8889bb70
Fix more docs errors. ( #39051 )
...
* Fix remaining unknown-document docs errors.
* Fix last toc-tree-missing-document docs error.
7 years ago
Matt Clay
7e96421132
Handle warnings in docs-build sanity test. ( #39043 )
7 years ago
Matt Clay
4fc5e89e83
Fix docs build warnings.
7 years ago
Alicia Cozine
64dcc7def0
Fixes more rST errors ( #39042 )
...
* removes include, avoids duplicate label rST warnings
* reduces literal_block errors on playbooks_filters
* addresses TOC errors
* ref error on modules page
* trying ref for list_of_database_modules
7 years ago
Alicia Cozine
408e29cbd2
Link fixes ( #39038 )
...
* fixes links on plugins pages
* fixes links in community pages
* fixes links in user guide
* adds anchors on playbooks pages
7 years ago
Toshio Kuratomi
6ddc64bc7c
Fixes for multiline doc descriotions breaking rst formatting
...
* strip whitespace to preserve indent level
* Make sure to indent subsequent lines of indentation
7 years ago
Toshio Kuratomi
a08459a814
Update info on python support ( #38855 )
...
* Update the documentation to list Python 3 as official
* Add some reference targets for inventory variables so we can link to docs
* Add a platform FAQ section
Populate it with
* virtualenv info (previously on the python3 support page)
* BSD (Link to the working with BSD page)
* Solaris (Document how to work around the non-POSIX shell on some
Solaris hosts)
Fixes #21594
* Fix some refs in the release_and_maintenance document
* Fix unindent error in module template
Fix for the module/plugin template unintentionally unindented inside of
a raw block, leading to errors like:
ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent.
* Make wording for Solaris troubleshooting better.
7 years ago
Alicia Cozine
0ebc0b9e5a
adds FAQ TOC entry, links & examples to modules ( #38706 )
...
* adds FAQ TOC entry, links & examples to modules
* moves link to Notes, corrects examples
7 years ago
Toshio Kuratomi
8cdd75a09f
Some more fixes for the docs :ref: disambiguation
...
The big one is that we needed to set plugin_type when we processed the by_support template.
Also added to list_of_CATEGORY_plugins page (which might not be used)
and corrected a place where I did module_name instead of name_module
7 years ago
Brian Coca
ce8c336d52
added ref to ansilbe molecule
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
f9d83944ec
regex for finding :ref: labels was flawed
...
The regex to find labels inside of angle brackets was not detecting
anything before so I missed all of those.
* Fixed the regex in find-plugin-refs to take care of that.
* Fixed plugin_formatter to emit namespaced labels for the M() macro.
7 years ago
Martin Krizek
8173602a34
Add expandvars jinja2 filter ( #38805 )
...
* Add expandvars jinja2 filter
* Add docs
* Minor edit
7 years ago
scottb
c97e508806
[WIP] disambiguating autogenerated module docs attempted fix of #38439 . ( #38890 )
...
Disambiguates autogenerated module docs - fixes #38439 .
7 years ago
Matt Clay
3d57f45815
Update httptester docs.
7 years ago
Toshio Kuratomi
a1b148d190
Fix shebang so sanity tests pass
7 years ago
Toshio Kuratomi
1f0cc54ec7
fixup style problems in new script
7 years ago
Toshio Kuratomi
6b1e6b8460
Add a script for finding bare plugin :ref:s
...
We're porting autogenerated plugin docs so that :ref: targets are
namespaced by plugin type. To do this effectively, we need to know
where all the :ref: targets which refer to the bare plugin names are in
the rst files. This script will find those.
7 years ago
Evgeniy Komissarov
92f4065157
Fix typo in windows_faq.rst ( #38864 )
...
Fix typo in `python-pip` packet name.
+label: docsite_pr
7 years ago
John R Barker
3d3781db57
Correct formatting ( #38874 )
7 years ago
Brian Coca
bdbb89378f
centralize doc/config plugin lists ( #38775 )
...
* centralize doc/config plugin lists
also update list for generation in docsite
added note to ensure they are in sync
* updated shell page to list plugins
added some more docs hinting at plugins being configurable
* fix edit link for plugins
7 years ago
Kenyon Ralph
3c6a362921
playbooks_async.rst: correct typo
7 years ago
Rémy Léone
d639d5dc96
Fix typo ( #38652 )
...
Typo
+label: docsite_pr
7 years ago
CsilLAB
521ea56e77
Add details to see decrypted vault value ( #37341 )
...
* Improves ansible-vault section of network getting started
7 years ago
Toshio Kuratomi
25523666ce
Modules that have a link to their own deprecated section need to use a different link syntax ( #38697 )
...
The :ref: syntax is for linking to targets which are defined for the
whole document tree. `link`_ is for linking to targets which are inside
of the document. We want the latter for deprecated sections because
otherwise we'd have to create namespaced link targets for them.
Also fix expansion of version a deprecated module will be removed in
7 years ago
Matt Clay
26fa3adeab
Add docs-build sanity test.
7 years ago
Will Thames
4ba29c8bf1
Use a temp directory that is more likely to exist ( #38645 )
...
`env:SystemDrive\temp` does not necessarily exist
`env:temp` is much more likely to exist. Use that
7 years ago
Qasim Sarfraz
6d830166e9
Minor typo fix ( #38589 )
7 years ago
Evgeni Golov
7376a9b946
fix with_<lookup> spelling ( #38584 )
...
trivial change ;)
+label: docsite_pr
7 years ago
Alicia Cozine
da6d2b5f43
corrects Junos network_cli example & variables ( #38601 )
...
* corrects Junos network_cli example & variables
* vdacosta feedback, thanks
7 years ago
Alicia Cozine
ea99cf3231
inaugural Network FAQ ( #38359 )
7 years ago
Martin Krizek
5297eac46d
playbooks_variables.rst: fix facts code-block ( #38520 )
7 years ago
Martin Krizek
f1e41cbb36
playbooks_intro.rst: remove duplicite playbook ( #38521 )
7 years ago
scottb
6454aedb44
Reinstate code of conduct to the community TOC; add links to code of conduct to a few conspicuous spots in the community guide. ( #38501 )
7 years ago
alekseyp
061ecac3b5
Update playbooks_loops.rst ( #38440 )
...
Missing parentheses
+label: docsite_pr
7 years ago
Pierre Templier
1e0df01980
Small typos in docs ( #38371 )
...
* Small typos in docs
* Use same wording as in porting_guide_2.5.rst
7 years ago
Abhijeet Kasurde
8bc7af2e34
Minor typo in installation guide ( #38452 )
...
Change subsription-manger to subscription-manager
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
scottb
d1d15dd025
Mobile CSS update - adds scrolling inertia ( #38443 )
7 years ago
Will Thames
a8953fcac4
Add documentation on dict2items ( #38375 )
...
dict2items is worth mentioning in the filters and loops pages
(the latter as it's useful to replace `with_dict`)
Update some nearby broken links
7 years ago
scottb
785964ea97
Tweaks docs CSS to fix minor issue with main content page display cutting off at the bottom. ( #38432 )
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
scottb
2381d2207e
Additional docs CSS fix for mobile ( #38376 )
7 years ago
scottb
79c5a34b0b
Fixes CSS so docs display properly on mobile ( #38373 )
7 years ago
Pierre Templier
2340ca7701
Small typos in docs ( #38370 )
...
* Small typos in docs
* Fixed wording
7 years ago
Elijah Lynn
95d40bcd0a
Update fish setup to use `source` instead of `.` ( #33207 )
...
"The use of . is deprecated in favour of source, and . will be removed in a future version of fish."
source: https://fishshell.com/docs/current/commands.html#source
7 years ago
Brian Coca
c62551c1b0
Update role doc examples ( #37844 )
...
* fix role examples
- also fixed issue with overload of 'name', fixes #37836
- attempted to clarify tag inheritance/application
* Typo fix
7 years ago
Brian Coca
5ad13d66aa
documented actual precedence ( #38009 )
...
fixes #22025
7 years ago
Christian Fetzer
9cca9a9c10
docs: Document disabling diff on task level ( #37998 )
...
* docs: Document disabling diff on task level
Tasks that deal with secrets may leak sensitive information when
running in Check Mode. This change updates the documentation explaining
that the diff can be deactivated on task level.
The feature was requested in #14860 and got introduced in Ansible 2.4
with #28581 .
* Updated for clarity
7 years ago
Pilou
2a604f6fe6
doc: index_var: fix version added ( #37982 )
...
e9b0a4ccb4
is present since v2.5.0b1
7 years ago
Jonas Meurer
55fd3d62fb
Update porting_guide_2.5.rst ( #37927 )
...
The example regarding `include_*` is a bit unclear. First it seems like the v2.4 and v2.5 examples are the same. So I attempted to make the relevant change in the examples more obvious.
label: docsite_pr
7 years ago
Dag Wieers
cdf9e39647
Fix the automatic docsite_pr label ( #37999 )
7 years ago
Sam Doran
34dca85417
Update installation docs for RHEL based distributions. ( #38056 )
...
Upstream rpms are no longer in Extras but EPEL as well as releases.ansible.com.
Add instructions for adding Ansible Engine repo to RHEL.
7 years ago
ewubnhn
ea9ece8e72
Update spelling_word_choice.rst ( #38113 )
...
Added missing format string on "Installer"
label: docsite_pr
7 years ago
Alicia Cozine
24fe8674a6
DOCS: Network Best Practices fixes ( #38293 )
...
* fixes typo per #38217 , corrects link anchor
* adds ssh-agent info per #35649
7 years ago
Scott Butler
62c2b9a544
Removes modules from TOC, speeding up build time and reducing doc disk space requirements.
7 years ago
Toshio Kuratomi
4165bb308b
Fix 2.5 changelog link
7 years ago
Toshio Kuratomi
8f1b5fc47b
Add alias's as a :ref: target for modules
...
This is especially important for deprecated modules as we want to link
to those in porting guides and such.
7 years ago
Toshio Kuratomi
73c80862c8
Update docs and version definitions for the 2.4.4 and 2.5.0 releases
7 years ago
Dylan Silva
45b5a486c6
2.6 roadmap doc ( #37926 )
...
* 2..6 roadmap doc
* Formatting & network items
* typo
7 years ago
Alicia Cozine
380c074808
demonstrates best practices for group vars ( #37930 )
...
* demonstrates best practices for group vars
* removes vm-specific var from example
* adds brackets to all [group:vars] refs
7 years ago
scottb
68f81a6799
Reinstated element to fix doc display on mobile devices. ( #38246 )
7 years ago
Matt Martz
a89d0d0919
Ensure that arguments for sub commands are properly indented ( #37992 )
7 years ago
Dag Wieers
70d49f7616
Fix indentation issue
...
<!--- Your description here -->
+label: docsite_pr
7 years ago
Sam Doran
b5b3beff83
Correct syntax highlighting in plugin dev docs ( #38184 )
...
Use rst em dash
7 years ago
Daniel
45e4dfda3d
doc: fix grammar ( #38145 )
7 years ago
Alicia Cozine
b72960fdd4
revises network portion of 2.5 porting guide ( #37938 )
...
* revises network portion of 2.5 porting guide
7 years ago
Colin Walters
290cca3613
docs/keywords: Clarify `async` a bit ( #37943 )
...
I hastily did a copy/paste of the `async` example and it took me
a while to understand that `async` specified a maximum runtime in seconds.
The docs are actually mostly clear on this, but I made this PR while
reading the code.
This also fixes the spelling of "asynchronously".
7 years ago
Joseph Herlant
00a7ff7974
Move man pages generations to rst2man ( #37861 )
7 years ago
Matt Martz
ffbbb5a25b
Use arg_spec type for comparisons on default and choices ( #37741 )
...
* Use arg_spec type for comparisons on default and choices
* Further improve type casting
* Make sure to capture output in more places
* Individually report invalid choices
* Update ignore.txt after resolving merge conflicts
7 years ago
scottb
3554e2c2d9
Fixes scrolling issue without breaking header nav ( #37864 )
7 years ago
scottb
47318a50b2
Temporary fix for horizontal scrolling issues on certain pages. Note that this will revert the behavior where headings scroll off the top of the main content region during navigation; fix for that is being investigated. ( #37863 )
7 years ago