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
4 years ago
Sandra McCann
7f9258b024
update backport instructions for 2.11 ( #71567 )
...
* update backport instructions in docs/docsite/rst/community/development_process.rst
Co-authored-by: Matt Martz <matt@sivel.net>
4 years ago
Alicia Cozine
29b20bd1b1
DOCS: Mentions ansible-base, adds collections pointers to Community and Dev Guides ( #71480 )
4 years ago
Remi Verchere
824cd4cbeb
Update ansible european IRC channel ( #71326 )
...
Signed-off-by: Rémi VERCHERE <remi@verchere.fr>
4 years ago
Alicia Cozine
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>
4 years ago
Sorin Sbarnea
b7ee07215d
Update Molecule support contact ( #70797 )
...
As Molecule started to use https://github.com/ansible-community/molecule/discussions we need to update documentation before retiring
the molecule-users mailing list.
4 years ago
Sandra McCann
2a7df5e07b
add note for write permission on rst files ( #70766 )
...
* add note for write permission on rst files
* Update docs/docsite/rst/community/documentation_contributions.rst
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
4 years ago
Alicia Cozine
f1f782fc37
partial update of community docs to reflect collections transition ( #70488 )
4 years ago
Andrew Klychkov
edcd1a1a70
Doc: fix examples of changelog entries. ( #70551 )
4 years ago
Abhijeet Kasurde
e4f48c920c
Docs: mention about Ansible workshops ( #70353 )
...
Lightbulb is deprecated in favor of https://ansible.github.io/workshops/
Update links accordingly.
Fixes : #70296
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Sandra McCann
647c6cd289
updates to ansible-maintained collections guidelines ( #70178 )
4 years ago
Jill R
8ad46870a4
Update note about AWS collection test requirements in docs ( #70176 )
4 years ago
Sandra McCann
2609482975
How to contribute to Ansible maintained collections ( #69202 )
...
contributor info with HTML table
4 years ago
Adriano C
bfc510a0f8
Update other_tools_and_programs.rst ( #69499 )
5 years ago
Dmitry
925199511e
Add JetBrains platform tools ( #69478 )
5 years ago
Andrew Klychkov
1e01ac413b
Improve the changelog-how-to documentation. ( #69268 )
...
* Improve the changelog-how-to documentation:
* remove repetitions
* mention starting with lowercase
* update the link to examples, remove an irrelevant link
* change win_ example to apt_repository
* add info about collections
5 years ago
Anatoly Pugachev
09f86c1410
docs: communications update ( #69687 )
...
* add some more info on IRC support channels to docs
5 years ago
Jon Dufresne
eab4f9afc4
docs: Small grammar improvement in the community guide ( #69304 )
...
The comma should not be included as it is not joining two independent
clauses.
5 years ago
Sandra McCann
7e0794085e
add links to new docsites ( #69310 )
5 years ago
Jeff Geerling
cfc9b4a1e2
Add Kubernetes Working Group to Communicating guide. ( #68028 )
5 years ago
Sandra McCann
f633772942
Update documenation contributions to reflect that some docs are in collections now ( #68264 )
5 years ago
Andrew Klychkov
ad8df69b58
docs/docsite/rst/: fix typos ( #67645 )
5 years ago
Marco Bellaccini
a8d72a9923
Adding nanvault to Other Tools list ( #67583 )
...
##### SUMMARY
Adding nanvault - a standalone tool to encrypt and decrypt files in the Ansible Vault format, featuring UNIX-style composability.
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
5 years ago
Sandra McCann
80f5503ed0
Use requirements.txt to install prereqs for docs build ( #65709 )
...
* Use requirements.txt to install prereqs for docs build
* implement feedback
5 years ago
Sandra McCann
94e98d5369
remove toshio as release manager (boohoo) ( #64685 )
5 years ago
Sandra McCann
f264e9cfca
update backport instructions to use stable-2.9 ( #64168 )
5 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://.
5 years ago
mohamed chiheb ben jemaa
e7436e278f
Remove Latin phrases from the docs ( #62419 )
...
* add styleguide about avoiding use of latin words
5 years ago
Glandos
2d19150757
Update mitogen link ( #62247 )
5 years ago
John R Barker
41055b5dc8
Proposals aren't really used much, delete it ( #61800 )
5 years ago
Toshio Kuratomi
019d078a5a
Move common build code from _build_helpers ( #55986 )
...
We have some common code used by several docs scripts. Migrate that
into the build-only shared code repository.
* Move lib/ansible/utils/_build_helpers.py to the directory for common
build code
* Migrate docs/bin/dump_config.py to a build-ansible subcommand
* Migrate dump_keywords to the build-ansible framework
* Make the script more maintainable by using functions and good
variable names
* Port to Python3 idioms
* Fix bug so that private attributes will be undocumented
* Move generate_man to a build-ansible subcommand
* Port plugin_formatter to a build-ansible subcommand
* Rework command_plugins so that docs scripts can target Python-3.4+ and
releng-only subcommands can use more recent versions of Python.
The architecture is now that command_plugins/* need to be importable
on Python-3.4. The init_parsers() method needs to run on Python-3.4.
But the main() method can utilize features of more recent Python as
long as it fits within those parameters.
* Update docs build requirements
Port the plugin_formatter to build-ansible framework
5 years ago
Alicia Cozine
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
5 years ago
Alicia Cozine
158f97bfb2
updates docs reqs to specify Pygments version, remove tornado ( #58007 )
6 years ago
Alicia Cozine
e834cd7d41
updates reqs for building docs locally ( #57967 )
6 years ago
Sviatoslav Sydorenko
dfaa72297c
Fix an RST link to the changelog config in docs
6 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
6 years ago
Sviatoslav Sydorenko
5183f84016
📝 Mention the minumum cherry-picker version in doc ( #57139 )
6 years ago
Kevin Breit
4742897635
Move backport guide to 2.8 ( #56578 )
...
The backport guide should refer to Ansible 2.8 instead of 2.7 as the target branch, since 2.8 is out.
6 years ago
Felix Fontein
6948e04276
Add myself to committer list. ( #56363 )
6 years ago
Caio Ramos
3bbc083818
Updating working groups links to community wiki ( #54482 )
...
Updating working groups links to community wiki and adding Working Groups wiki link (https://github.com/ansible/community/wiki#working-groups )
+label: docsite_pr
6 years ago
Toshio Kuratomi
f5f4948480
Remove nose from unittests ( #54055 )
...
* Remove nose from unittests
This PR migrates the last of our unittests from using nose to using
pytest. We don't need to install nose in our testing environments
anymore
6 years ago
Sandra McCann
2c0897caf2
mention ansible-lint and editor tools that help with playbook development ( #51769 )
...
* introduce ansible-lint in playbook docs, mention editors help playbook syntax
Co-Authored-By: samccann <samccann@redhat.com>
6 years ago
mclean
8e9a5c8de7
changes 'github' to 'GitHub' in community ( #51111 )
...
* changes 'github' to 'GitHub' in community
6 years ago
Simon Legner
33b9c880a4
Consistent typesetting of "GitHub" ( #50929 )
6 years ago
Bianca Henderson
52843fcabc
Making changes to the Community Guide index ( #49670 )
6 years ago
John R Barker
c3d579c52a
Docker & Remote Management Working Groups ( #49023 )
...
* Adds Docker & Remote Management Working Groups
6 years ago
John R Barker
3433ca286d
Docs reorg /community/index & /dev_guide/index ( #48734 )
...
* Improved community/index.rst makes it easier to find existing content
6 years ago
Martin Krizek
9ce9c9698a
committer_guidelines.rst: update core committers ( #48662 )
...
* committer_guidelines.rst: update core committers
* Another update
6 years ago
Adam Miller
2b1ca25e59
docs - adapted abadger's changelog announcement email into dev process ( #48172 )
...
* docs - adapted abadger's changelog announcement email into dev process
Signed-off-by: Adam Miller <admiller@redhat.com>
* migrate changelog docs to one place, add ref to old location
Signed-off-by: Adam Miller <admiller@redhat.com>
* add changes based on feedback
Signed-off-by: Adam Miller <admiller@redhat.com>
* Refines changelog docs, minor re-org of page
* moves links and anchors for new content
* Further reorg of page
* fixes header per jamescassell
6 years ago
Andreas Krüger
806442b3ec
Document the tests that are currently run on documentation pull requests. ( #48436 )
6 years ago
Bianca Henderson
e38796bf7b
Slight Change in Wording in "Reporting Bugs and Features" ( #47984 )
...
* Adding a link for PR info
* Not specifying Google Groups in wording
6 years ago
Bianca Henderson
248827227a
Correcting syntax of PyYAML package ( #47987 )
6 years ago
John R Barker
f536944e3a
Molecule is now IRC: ansible-molecule ( #47860 )
6 years ago
John R Barker
4572d9ccd7
ansible-lint and molecule part of Red Hat ( #47826 )
6 years ago
Bianca Henderson
e6d99cb2bf
Adding a link for PR info ( #47778 )
6 years ago
John R Barker
d189e58f63
Correct AWX community link ( #47742 )
6 years ago
John R Barker
749af9fd22
Document all Working Group, email lists and IRC channels ( #47615 )
...
Put all communication info in one place so we can update links to point here.
6 years ago
John R Barker
166e84b9c4
Docs: No need to follow up on backport PRs ( #47616 )
...
Also tidy up `notes` section into a single box
6 years ago
Alicia Cozine
4219d25fc7
Add docs about contributing to docs ( #46481 )
...
* adds page on community contributions to docs
6 years ago
Haidara Mohamed El Mouctar
cd4415d4ec
Docsite: Add a new tool: Ansible Playbook Grapher ( #46435 )
...
Add Ansible Playbook Grapher: a tool create a graph representing your Ansible playbook tasks and roles.
https://github.com/haidaraM/ansible-playbook-grapher
+label: docsite_pr
6 years ago
Alicia Cozine
f430f60541
Restore license agreement ( #45809 )
...
* adds page for CLA in community docs with links from dev and community docs
6 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
6 years ago
Sam Doran
5d6f844eba
Add docs on how to write changelog fragments ( #42428 )
...
* Add docs on how to write changelog fragments
* Make recommended changes
* Restore lines and make recommended changes
* Add link to new style changelog
Remove redundant mention of old style changelog
6 years ago
Alicia Cozine
9a76441c02
rewrite of the developer guide, part 1 ( #45179 )
...
* rewrite of the developer guide, part 1
6 years ago
Andreas Olsson
00e5123e4c
Update documentation based on 301 permanent redirects ( #43675 )
6 years ago
Andreas Olsson
4a0b32083c
Fix link description typo in tools documentation ( #43828 )
6 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.
6 years ago
John R Barker
321081c3b4
atom & yamllint ( #43498 )
...
* atom & yamllint
6 years ago
Ajay Chenampara
d79027b77f
Update with Emacs info ( #43450 )
...
* Update other_tools_and_programs with Emacs info
6 years ago
John R Barker
3ab9030f05
Document more tools ( #43053 )
...
* Document more tools
6 years ago
Sviatoslav Sydorenko
97cc0cce7f
🚸 🐍 🍒 ⛏ Integrate cherry picker ( #41403 )
...
This enables developers to use cherry-picker for backporting purposes.
This tool originally comes from Core Python Development Workflow.
Ref: https://pypi.org/p/cherry-picker
Ref: https://github.com/python/core-workflow/tree/master/cherry_picker
Also:
* 📝 Add docs about supporting cherry-picker
6 years ago
Sam Doran
3e2a4f67cf
Update link to GitHub admin process ( #42364 )
6 years ago
Alexandre Vicenzi
df2e0c7c00
Fix broken links. ( #42323 )
6 years ago
David Moreau Simard
8c27ffdf90
Add ARA Records Ansible to community tools ( #39836 )
...
ARA is an Ansible callback that records playbook run data in a local
or remote database. This data is exposed through a CLI client as well
as a reporting web application.
7 years ago
Andrew Gaffney
4134f1204b
Add Andrew Gaffney to list of people in Committers Guidelines doc
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
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
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
Brian Coca
ce8c336d52
added ref to ansilbe molecule
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
Martin Krizek
bcfff1c818
docs: needs_rebase is still used ( #37774 )
7 years ago
scottb
381359a8f8
Doc build warning/broken link clean-a-palooza ( #37382 )
...
* Doc build warning/broken link clean-a-palooza, WIP commit 1.
* Fixed broken anchor
* Fixing additional broken links; converting from doc to ref.
* Fix anchor
7 years ago
Matt Martz
076ea07bb5
Add instructions for creating backport PRs ( #36593 )
...
* Add instructions for creating backport PRs
* Update development_process.rst
simpler workflow
* Update development_process.rst
added origin note
* A few adjustments to clarity, use backport instead of cherry pick in branch name
* Address formatting issue
* fetch isn't a flag
* Fix rst formatting
7 years ago
scottb
373b1dcf59
Core Docs Refactor and Redesign ( #36067 )
...
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79 . Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.
* Adding extra blank line for shippable
7 years ago
John R Barker
3fadc5d614
Formatting and broken links ( #35226 )
7 years ago
Toshio Kuratomi
94d952f94b
Documentation on how to make a release. ( #31426 )
...
* Release Engineering Docs with pointer to the Docs on how to actually make the release.
7 years ago
John R Barker
6e4aa49a31
No hardcoding roadmaps ( #32981 )
7 years ago
Lindsay Hill
146f90e16b
Fixed RST hyperlink issues ( #31394 )
7 years ago
Toshio Kuratomi
c82cf791dd
Add a code-smell test for smart quotes and remove smart quotes from all files
7 years ago
Will Thames
c749ecbd94
Add ansible-inventory-grapher to the list of tools ( #29068 )
...
* Add ansible-inventory-grapher to the list of tools
* Fixed minor typo.
7 years ago
scottb
b146e17733
Edit pass for relocated community documentation. ( #28368 )
...
* Edit pass for relocated community documentation.
* Updated info on Ansibullbot
Fixed improper link syntax
Change links to point to new documents
Changed Ansibot to Ansibullbot
Clarified workflow
Change formatting on commans and tags
* Update communication.rst
Add Contents
Use correct headings
* Update communication.rst
* Topics, remove whitespace, codeofconduct
* Formatting
* Correct heading
* Update maintainers.rst
* Minor edits and a request for more info
* Removed some hard-to-localize wording.
* Removed incomplete sentence
* Minor edits per review
7 years ago
Chris Houseknecht
d513c430de
Updates community code of conduct email
7 years ago
Toshio Kuratomi
84ea2af4b6
Remove nonexistent special_interest-groups doc
7 years ago
Greg DeKoenigsberg
d78c199972
Update triage_process.rst to link to ansibullbot ( #28137 )
...
* Update triage_process.rst to link to ansibullbot
* fix typo
7 years ago
Greg DeKoenigsberg
75c0c545fd
Create other_tools_and_programs ( #28138 )
...
* Create other_tools_and_programs
From https://github.com/ansible/community/issues/5 .
* Fix typo
7 years ago
Greg DeKoenigsberg
b3ed699132
Copying code of conduct from community.rst ( #28136 )
7 years ago
Greg DeKoenigsberg
608c69279c
Moving "communication" info from main community page ( #28135 )
7 years ago
Greg DeKoenigsberg
5f6bfd81f8
Copying content from MODULE_GUIDELINES.md ( #28131 )
7 years ago
Adrian Likins
a2c8b03b46
fix rst format errors making rstcheck fail ( #28129 )
7 years ago