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>
2020-09-24 15:00:17 -05:00
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
2020-09-03 14:47:57 -05:00
Andrew Klychkov
cda5854099
Docsite: improve spelling_word_choice.rst ( #71592 )
2020-09-02 09:24:53 -04:00
Sandra McCann
748ba96610
How to use rst :ref: for modules in collections ( #70567 )
2020-07-28 17:40:16 -05:00
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>
2020-06-16 11:50:50 -05:00
Sandra McCann
4fedc10035
added guidelines for seo; ( #66431 )
2020-01-13 15:46:44 -06:00
Austin Macdonald
1aee11c860
add newline to render table correctly ( #63769 )
2019-10-29 13:09:18 -04:00
Andreas Olsson
c8315bfd60
Prefer https:// links in the docs site ( #62939 )
...
This is a follow-up of last year's 1a11cec
2019-09-30 15:11:19 -04:00
mohamed chiheb ben jemaa
e7436e278f
Remove Latin phrases from the docs ( #62419 )
...
* add styleguide about avoiding use of latin words
2019-09-26 15:12:24 -04:00
Sandra McCann
5243cba0b2
describe how to link to modules or plugins ( #57806 )
2019-06-13 12:52:40 -05:00
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
2019-05-31 14:24:44 -05:00
Xaroth
646a8586a5
Remove old 'srtd' theme and references. ( #49289 )
2019-03-05 12:22:17 -06:00
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.
2019-01-24 16:09:41 -06:00
Alicia Cozine
a71cd49a0c
Style guide index ( #49746 )
...
* First revision of ansible style guide index page
2018-12-10 15:32:45 -05:00
Sandra McCann
32c2b3b3be
Styleguide basic ( #49747 )
...
* cleaned up basics page
* made codeblock visible
* added anchor
2018-12-10 14:30:34 -06:00
trogdor_the_burninator
b3c277decc
[FIX] grammatical structure of phrase ( #49660 )
2018-12-07 16:55:45 -06:00
Alicia Cozine
4219d25fc7
Add docs about contributing to docs ( #46481 )
...
* adds page on community contributions to docs
2018-10-24 11:14:01 -04:00
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
2018-09-11 17:51:47 +01:00
Donghyun Kang
5fecf8baab
doc: fixed typo ( #44685 )
2018-08-26 21:36:11 +02:00
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.
2018-08-01 08:20:40 -07:00
Matt Clay
c262dbfd30
Use https for links to ansible.com domains.
2018-04-23 11:33:56 -07:00
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
2018-04-20 12:17:02 -07:00
ewubnhn
ea9ece8e72
Update spelling_word_choice.rst ( #38113 )
...
Added missing format string on "Installer"
label: docsite_pr
2018-04-05 10:45:42 -07:00
Lars Kellogg-Stedman
29fbf0c756
remove erroneous '.' in docsite footer ( #34592 )
...
This removes an erroneous '.' in the docsite that someone pointed out
on irc.
2018-01-08 22:36:47 -08:00
Michihito Shigemura
b3cee37dc1
Update links in style_guide/trademarks ( #30809 )
2017-09-27 01:29:56 -07:00
Michihito Shigemura
b3177383da
Fix typo in docs spelling_word_choice ( #30785 )
...
shocked that someone else spells the correst way, like me
2017-09-25 11:09:18 -04:00
Michihito Shigemura
303d622dcb
Refactor doc resources in style_guide ( #30794 )
...
- Change links from http to https
- Correct or remove dead links
2017-09-23 09:13:17 +00:00
Michihito Shigemura
b5546328dc
Fix typo in docs grammar_punctuation ( #30718 )
2017-09-22 10:18:26 +00:00
Toshio Kuratomi
c82cf791dd
Add a code-smell test for smart quotes and remove smart quotes from all files
2017-09-18 16:49:16 -07:00
Matt Clay
cec2b960f8
Fixes for pep8 and rstcheck issues.
2017-05-05 10:47:05 +08:00
scottb
02057f481b
Added style guide ( #24310 )
...
* Added style guide
* Fixed index
2017-05-04 13:25:13 -07:00
