Sandra McCann
4e63b681f2
Add a banner message to warn when not on latest documentation ( #58526 ) ( #58765 )
...
* add banner to versions that are not latest
(cherry picked from commit 35b6345bdc )
7 years ago
Felix Fontein
b7f15c69b1
[2.7] docsite: remove lexers which have been fixed in Pygments 2.4.0 ( #58101 )
...
* docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508 )
* Remove lexers which have been fixed in Pygments 2.4.0.
* Add Pygments >= 2.4.0 to test runner.
* Fix pages that triggered lexer errors.
Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
(cherry picked from commit 505c99265c )
* fixes 'could not lex literal_block' errors
7 years ago
Alicia Cozine
c7fece19e5
Docs: add Pygments lexer for Ansible output ( #50318 ) ( #58356 )
...
* Add specialized lexer for Ansible output.
* Make linter happy.
* Use different tokens.
(cherry picked from commit 9657a21438 )
7 years ago
Alicia Cozine
17cbece6df
Backport/2.7/55655 ( #58097 )
...
* Add dropdown version selection to docsite (#55655 )
(cherry picked from commit f3720c90e0 )
7 years ago
Ed Costello
5dcb20dfdb
Replace links to AWS module guidelines with links to devel docsite since ( #57466 )
...
the GUIDELINES.md has been moved to the docsite.
7 years ago
Sandra McCann
31fc9f9260
backport 57316 ( #57424 )
7 years ago
Alicia Cozine
52de0b4e61
Removed misleading padding from highlighted results of a search query ( #55464 ) ( #56654 )
...
(cherry picked from commit 0330ea616e )
7 years ago
Alicia Cozine
9e9db8a17d
Speed up the Sphinx documentation build ( #55593 ) ( #56662 )
...
* speeds up the docs build by changing the navigation collapse setting
(cherry picked from commit 47a440774f )
7 years ago
Alicia Cozine
2d414b2778
Update default roles_path documentation ( #56320 ) ( #56665 )
...
(cherry picked from commit c1ebc8d9c2 )
7 years ago
Alicia Cozine
f4ce200b97
creates reversed glob TOCs for porting guide and roadmap index pages ( #56655 )
7 years ago
Sandra McCann
84ade9f7b6
fix backport issues ( #56648 )
7 years ago
Sandra McCann
22194345d0
Update Ansible docsite CSS to fix multi-page printing issue ( #51472 ) ( #55666 )
...
* Update css to fix multi-page printing issue
* Add margin edit
(cherry picked from commit 51ac4d3441 )
7 years ago
Jordan Borean
e093b8a07e
SCP filename validation docs ( #55399 )
...
* SCP filename validation docs
* Update docs/docsite/rst/reference_appendices/faq.rst
Co-Authored-By: jborean93 <jborean93@gmail.com>
* Update docs/docsite/rst/reference_appendices/faq.rst
Co-Authored-By: jborean93 <jborean93@gmail.com>
* Update docs/docsite/rst/reference_appendices/faq.rst
Co-Authored-By: jborean93 <jborean93@gmail.com>
* edits to scp FAQ entry
* zeut alors I have missed one
* incorporate jborean feedback
* adds link to bug report
(cherry picked from commit 8542f16fa9 )
7 years ago
Sandra McCann
c44c38cdc2
Clarify platform EOS and NXOS table settings ( #55096 ) ( #55174 )
...
(cherry picked from commit 7a1e2ef746 )
7 years ago
Felix Fontein
c58f0a7b8d
doc: preseve block-quote structure ( #53293 ) ( #55072 )
...
Without the `::`, the indentation of the example block is lost.
(cherry picked from commit 0b579a0837 )
7 years ago
Paul Puschmann
4b28413446
Backport/2.7/50183 ( #55035 )
...
* gcp: documentation update (#50183 )
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit ae404d1476 )
* Add changelog-document for gcp_inventory improvement
7 years ago
Evan Kaufman
384781d0ea
[stable-2.7] replace - fixed combined before and after usage ( #31452 )
...
When using before and after in combination, the opposite behavior was induced. This PR makes the the replacement happen between the specified patterns as intended.
* Added integration tests
* Add changelog, porting guide entry, and minor doc fixes.
(cherry picked from commit cf69ec5db0 )
Co-authored-by: Evan Kaufman <evan.kaufman@gmail.com>
7 years ago
Sandra McCann
f56c3fdc89
add link to AWS module details ( #53126 )
...
* add link to AWS module details (in 2.7 docs to stable-2.7 branch)
7 years ago
Alicia Cozine
821f43eb9a
refines vmware sample scenario page ( #47320 ) ( #52134 )
...
(cherry picked from commit cd7232eeb7 )
7 years ago
Toshio Kuratomi
30824c92e6
[stable-2.7] Toshio is now release manager for 2.8 and future 2.6 ( #51452 ).
...
(cherry picked from commit b0ac7d9652 )
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
7 years ago
Sandra McCann
c372d95c69
add network roles info ( #49501 ) ( #51400 )
...
* add network roles info
* add role update instructions
* implemented feedback
Co-Authored-By: samccann <samccann@redhat.com>
(cherry picked from commit 47d22bbcd8 )
7 years ago
Dag Wieers
34113f6cc5
Docs: Fix highlight line ( #50756 )
...
(cherry picked from commit 646c34dcde )
7 years ago
Dag Wieers
a22f46bacf
Docs: Add a "seealso" section to the module docs ( #45949 )
...
* Docs: Add a separate "seealso" section to the module docs
to list related modules and/or related references. This clears up the notes
section for things that are actual notes.
So you can add a section in your module documentation and four types of
references are possible.
seealso:
# Reference by module name
- module: aci_tenant
# Reference by module name, including description
- module: aci_tenant
description: ACI module to create tenants on a Cisco ACI fabric.
# Reference by rST documentation anchor
- ref: aci_guide
description: Detailed information on how to manage your ACI infrastructure using Ansible.
# Reference by Internet resource
- name: APIC Management Information Model reference
description: Complete reference of the APIC object model.
link: https://developer.cisco.com/docs/apic-mim-ref/
This PR also includes:
- Implements ansible-doc support
- Implements schema support for the seealso options
- Updates to the development documentation
- Rename filter convert_symbols_to_format to rst_ify, cfr the existing html_ify and tty_ify filters
- This makes the existing template a lot easier to read and fixes the confusion I had myself rereading the template (again).
- We fixed the possible suboption types (which was limited to 'bool' only)
* Use latest stable instead of devel docs
(cherry picked from commit baf0ad2309 )
7 years ago
Dag Wieers
f67081e97b
Clarify gather_facts and highlight important lines
...
Clarify gather_facts and highlight important lines
+label: docsite_pr
7 years ago
Abhijeet Kasurde
f201aa8948
[Backport 2.7] VMware: Fix vmware_vm_inventory
...
* Added documentation around using vmware dynamic inventory plugin
* Fixed bug for populating host_ip in hostvars for given inventory host
* VMware: Add properties in vmware_vm_inventory
Fixes : #50249
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit af914695e6 )
7 years ago
Sandra McCann
85764a00c4
link to KB article -certified modules ( #50050 ) ( #50052 )
...
(cherry picked from commit b873f34ea3 )
7 years ago
Martin Krizek
feb971f649
docs: remove not implemented password_hash feature ( #49945 ) ( #50008 )
...
(cherry picked from commit 79947245e2 )
7 years ago
Tim Burke
c7677eee83
Fix ReST formatting for Galaxy docs link ( #49575 )
...
(cherry picked from commit 6e43f9fe8f )
7 years ago
Matt Clay
7a0e86551d
Support skip of platforms by version in tests. ( #48826 )
...
* Support skip of platforms by version in tests.
Previously a remote platform could be skipped completely using the alias:
`skip/{platform}` such as `skip/rhel`
Now a specific platform version can be skipped using the alias:
`skip/{platform}{version}` such as `skip/rhel7.6`
This feature is available for platforms specified with the `--remote` option.
* Add skip by version to the docs.
(cherry picked from commit 8066acc90c )
7 years ago
Xaroth
14fc00f28b
[stable-2.7] -Change: set the 'canonical_url' theme option to enable rendering of canonical urls, promoting the 'latest' docs to search engines. ( #49190 ) ( #49214 )
...
(cherry picked from commit 59e7a9442e )
Co-authored-by: Xaroth <xaroth+github@xaroth.nl>
7 years ago
Matt Martz
edae7b0524
[stable-2.7] Prevent metadata changes in a stable branch ( #48994 ) ( #49131 )
...
* [stable-2.7] Prevent metadata changes in a stable branch (#48994 )
(cherry picked from commit 7287d39 )
Co-authored-by: Matt Martz <matt@sivel.net>
* Fix metadata comparison
7 years ago
John R Barker
eab6034c79
Update guide_packet.rst ( #49007 ) ( #49029 )
...
Properly parses the returned data to get the device data and IP address.
(cherry picked from commit 679b7dce63 )
7 years ago
Toshio Kuratomi
cef08640a4
[stable-2.7] Add an example to serial usage ( #48669 )
...
(cherry picked from commit b759862daa )
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
7 years ago
Sandra McCann
093ab2170d
fix toc issue ( #48616 )
7 years ago
Brian Coca
9389862d97
added faq entry on ansible_host + delegation ( #48438 )
...
(cherry picked from commit 7ca6af396e )
7 years ago
Abhijeet Kasurde
709845436e
Update plugin filter documentation ( #46665 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 6d36849f72 )
7 years ago
Martin Krizek
64b6637a6f
ansible-galaxy docs: fix init of container role ( #47853 )
...
(cherry picked from commit ec32bda2ef )
7 years ago
Alicia Cozine
dfdc7ec90c
Updates variables docs: facts examples, headers, links, etc. ( #47767 )
...
* refreshes ansible facts output and updates some references/headers
(cherry picked from commit 7db63851e0 )
7 years ago
Andrea Perotti
af18d3c451
Updates intro to dynamic inventory page ( #46799 )
...
* Added Foreman to the list of inventory scripts
(cherry picked from commit 8bc4a18500 )
7 years ago
Alicia Cozine
b17142358a
updates language about documentation versions and releases on index page ( #46465 )
...
(cherry picked from commit e97391b7ab )
7 years ago
Alicia Cozine
bc1d0f5e61
removes docs/api dir from .gitignore and Makefile ( #47366 )
...
* removes docs/api dir from .gitignore and Makefile
* reduces noise on removing build artifacts
(cherry picked from commit f1ad012375 )
7 years ago
Alicia Cozine
86eb3b5b98
adds stub API docs in a single file ( #46663 )
...
* adds stub API docs in a single file
(cherry picked from commit 9764f32513 )
7 years ago
Sloane Hertel
68aa3e24a8
cherrypick for #46786
7 years ago
Sloane Hertel
ed5f0d5c45
Add docs for inventory caching ( #46402 )
...
* Add docs for inventory caching
* Fix subsection headers
* Fix top header
(cherry picked from commit c4d1f0d416 )
7 years ago
Deric Crago
58cd460952
moved 'strftime' filter into 'Other Useful Filters' section ( #45801 )
...
(cherry picked from commit 065b7ac300 )
7 years ago
Sandra McCann
30acec79f4
Infoblox scenario guide ( #45664 )
...
* creates infoblox scenario guide
* adds link to infoblox guide from modules
* adds WAPI to prerequisites
(cherry picked from commit df3655968f )
7 years ago
Sandra McCann
3438429e22
WIP: fix build errors due to missing certified_supported label ( #46835 )
...
* fix build errors due to missing certified_supported label
* fixed references and toc
(cherry picked from commit db3d920cfd )
7 years ago
Abhijeet Kasurde
2f55215db2
VMware: improve readability and fix privileges names on scenario_clone_template ( #47960 )
...
(cherry picked from commit 89f03314ce )
7 years ago
Abhijeet Kasurde
c18eb52ade
VMware: Fix documentation for cloning template ( #47847 )
...
Fixes : #46700
(cherry picked from commit ab0d90f882 )
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
John R Barker
1bf3d54e01
Molecule is now IRC: ansible-molecule ( #47860 ) ( #47863 )
...
(cherry picked from commit f536944e3a )
7 years ago