Sandra McCann
f09e6b7769
Backportapalooza 06 16 ( #78072 )
...
* Docsite: Updated style guide resources (#78048 )
(cherry picked from commit 561cf1956d )
* Create reusable role layout snippet for documentation (#78057 )
* reuse role structure
* reuse role snippet in role docs
(cherry picked from commit f4ad1c771e )
* Docsite: update links to community docs (#78043 )
(cherry picked from commit 46d86a882d )
* Windows - incorrect python-devel package in WinRM docs (#78037 )
Co-authored-by: Emanuele Barbato <manu@Giuseppes-MacBook-Air.local>
(cherry picked from commit 681dc6eab9 )
* issue #72449 winrm script rm (#77931 )
(cherry picked from commit 3cd2c494bd )
* reword the regex note (#75393 )
Co-authored-by: Matt Martz <matt@sivel.net>
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
(cherry picked from commit 66c0882314 )
* Document debconf interaction with dpkg-reconfigure (#74196 )
Signed-off-by: David Greaves <david@dgreaves.com>
(cherry picked from commit 5b90601ca4 )
Co-authored-by: Lewis Brogan <ilewisbrogan@gmail.com>
Co-authored-by: Andrew Klychkov <aklychko@redhat.com>
Co-authored-by: Emanuele Barbato <30394740+emanuelebarbato@users.noreply.github.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: David Greaves <david@dgreaves.com>
4 years ago
Sandra McCann
8291dbdf81
add accessibility guidelines to docs style guide ( #77145 )
...
Co-authored-by: Jill R <4121322+jillr@users.noreply.github.com>
4 years ago
Sandra McCann
cfe4bdc1b9
Create separate core vs collection contributor guides ( #76764 )
...
* updated core guides
* ansible package docs guides
* add core guide to Ansible docs
* Update docs/docsite/rst/community/maintainers.rst
4 years ago
Aine Riordan
2346f93961
Docs: Fix section header notation in Style Guide ( #75720 )
4 years ago
Alicia Cozine
3c3e30a610
Docs: Add Matrix as a chat option ( #75406 )
4 years ago
Toshio Kuratomi
80e7e1a17c
Due to the takeover of freenode we're moving to a different irc network. ( #74775 )
...
* Due to the takeover of freenode we're moving to a different irc network.
* Our channels updated to point at the same channel name on libera.chat
* Some links went to webchat.freenode.net. At this time, libera.chat
doesn't point you to an official webchat client so I changed these to
https://libera.chat . (kiwi irc does work with libera.chat so that
could be another option).
* In general, I used the name irc.libera.net for link names and
https://libera.chat for link targets. This is because the irc service
is hosted on irc.libera.chat but the project web server is hosted on
libera.chat. (This appears to also be true for freenode but we were
using http://irc.freenode.net which doesn't seem to work. Oops).
* Removed http://irc.freenode.net from the linkcheck exceptions.
linkcheck was actually correct to flag that as invalid (should have
been http://frenode.net instead).
* Looks like hte important people in #yaml are now in libera.chat
* Link to where contributors should get help
Add a link target and then link to where contributors should get support
for developing groups of modules.
* Update docs/docsite/rst/dev_guide/developing_modules_in_groups.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
5 years ago
Bill Nottingham
34c9ed8a28
Product-related updates. ( #74454 )
5 years ago
Abhijeet Kasurde
8d499bbc83
Update Kubernetes collection name in docs ( #74440 )
5 years ago
Ronald Eddy Jr
d18901dd4a
Update HTTP -> HTTPS ( #72244 )
...
Co-authored-by: Ronald Eddy Jr <ron@Ronalds-MacBook-Pro.local>
5 years ago
Abhijeet Kasurde
4f990e7615
dev_guide: Add Pygments Lexer examples ( #71458 )
...
* dev_guide: Add Pygments Lexer examples
Fixes : #51307
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
* adds ansible-output lexer, remmoves unsupported lexers
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
5 years ago
Andrew Klychkov
7bfeed3e24
Docsite: replace Latin phrases to English ( #71588 )
...
Replace Latin phrases like "e.g." and "i.e." and "etc." with English phrases.
* Update docs/docsite/rst/community/committer_guidelines.rst
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst
* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst
* Update docs/docsite/rst/dev_guide/module_lifecycle.rst
* Update docs/docsite/rst/user_guide/intro_inventory.rst
* Update docs/docsite/rst/user_guide/playbooks_loops.rst
* Update docs/docsite/rst/user_guide/playbooks_reuse.rst
* Update docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst
* Update docs/docsite/rst/dev_guide/testing.rst
* Update docs/docsite/rst/dev_guide/testing_integration.rst
* Update docs/docsite/rst/porting_guides/porting_guide_2.5.rst
* Update docs/docsite/rst/reference_appendices/faq.rst
5 years ago
Andrew Klychkov
cda5854099
Docsite: improve spelling_word_choice.rst ( #71592 )
5 years ago
Sandra McCann
748ba96610
How to use rst :ref: for modules in collections ( #70567 )
5 years ago
Sandra McCann
c9c8cd34b2
added documentation for R() ( #69832 )
...
* Updated docs/docsite/rst/dev_guide/developing_modules_documenting.rst, added documentation for R()
* added link to how to add anchors, anchor, and clarification on when to use each option
Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
6 years ago
Sandra McCann
4fedc10035
added guidelines for seo; ( #66431 )
6 years ago
Austin Macdonald
1aee11c860
add newline to render table correctly ( #63769 )
6 years ago
Andreas Olsson
c8315bfd60
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://.
6 years ago
mohamed chiheb ben jemaa
e7436e278f
Remove Latin phrases from the docs ( #62419 )
...
* add styleguide about avoiding use of latin words
6 years ago
Sandra McCann
5243cba0b2
describe how to link to modules or plugins ( #57806 )
7 years ago
Bill Nottingham
c493593b4b
Adjust assorted terminology and wording around product offerings. ( #57242 )
...
* Adjust assorted terminology and wording around product offerings.
* Update docs/docsite/rst/dev_guide/style_guide/trademarks.rst
* Update docs/docsite/rst/user_guide/modules_support.rst
* Update docs/docsite/rst/reference_appendices/tower.rst
7 years ago
Xaroth
646a8586a5
Remove old 'srtd' theme and references. ( #49289 )
7 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.
7 years ago
Alicia Cozine
a71cd49a0c
Style guide index ( #49746 )
...
* First revision of ansible style guide index page
7 years ago
Sandra McCann
32c2b3b3be
Styleguide basic ( #49747 )
...
* cleaned up basics page
* made codeblock visible
* added anchor
7 years ago
trogdor_the_burninator
b3c277decc
[FIX] grammatical structure of phrase ( #49660 )
7 years ago
Alicia Cozine
4219d25fc7
Add docs about contributing to docs ( #46481 )
...
* adds page on community contributions to docs
7 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
7 years ago
Donghyun Kang
5fecf8baab
doc: fixed typo ( #44685 )
7 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.
7 years ago
Matt Clay
c262dbfd30
Use https for links to ansible.com domains.
8 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
8 years ago
ewubnhn
ea9ece8e72
Update spelling_word_choice.rst ( #38113 )
...
Added missing format string on "Installer"
label: docsite_pr
8 years ago
Lars Kellogg-Stedman
29fbf0c756
remove erroneous '.' in docsite footer ( #34592 )
...
This removes an erroneous '.' in the docsite that someone pointed out
on irc.
8 years ago
Michihito Shigemura
b3cee37dc1
Update links in style_guide/trademarks ( #30809 )
8 years ago
Michihito Shigemura
b3177383da
Fix typo in docs spelling_word_choice ( #30785 )
...
shocked that someone else spells the correst way, like me
8 years ago
Michihito Shigemura
303d622dcb
Refactor doc resources in style_guide ( #30794 )
...
- Change links from http to https
- Correct or remove dead links
8 years ago
Michihito Shigemura
b5546328dc
Fix typo in docs grammar_punctuation ( #30718 )
8 years ago
Toshio Kuratomi
c82cf791dd
Add a code-smell test for smart quotes and remove smart quotes from all files
8 years ago
Matt Clay
cec2b960f8
Fixes for pep8 and rstcheck issues.
9 years ago
scottb
02057f481b
Added style guide ( #24310 )
...
* Added style guide
* Fixed index
9 years ago