61b81bcd10
Docsite: improve reporting_bugs_and_features.rst ( #75234 )
...
* Docsite: improve reporting_bugs_and_features.rst
* Add clarification
3 years ago
8372f34b67
docs: Update description and URL for the ara repository ( #75283 )
...
The repository has moved from /openstack/ to /ansible-community/ some
time ago.
3 years ago
2eb9921b19
Prefer https:// links in the docs site ( #75121 )
...
This is a follow-up of previous years' 1a11cecc8315bf
3 years ago
58f26388be
Update docs requirements list ( #74956 )
...
* removes upper bound on sphinx version
* updates versions of docs build dependencies, adds known good requirements file
* adds instructions for using known_good_reqs file
3 years ago
3a8fc2d2be
Syntax fixes for docs ( #75086 )
3 years ago
2387ce311f
remove reference to container ML ( #75014 )
3 years ago
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>
4 years ago
16e1172292
Update docs for cloud maintained collections ( #74373 )
...
- AWS has moved to Zuul CI
- Kubernetes collection has been renamed
- OpenShift/OKD collection was missing
- ansible.windows is on Zuul and Azure Pipelines
- ansible.posix is on Zuul
Signed-off-by: Jill Rouleau <jill.rouleau@bespokess.com>
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
4bf420706b
Improve and extend changelog logs ( #74106 )
...
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
5463cbb841
Docs: communication.rst - add ansible-community to the IRC channel list ( #74570 )
4 years ago
8bd599d048
Change Shippable refs in docs to Azure Pipelines.
4 years ago
b765d3799b
update backporting instructions to reflect new latest stable branch, some edits ( #74512 )
...
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
34c9ed8a28
Product-related updates. ( #74454 )
4 years ago
fdbef02923
Update docs on working on docs ( #74201 )
...
* Fix the Makefile's htmlsingle command.
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
4 years ago
3bccfb1615
Updating Community docs with DO information ( #74019 )
4 years ago
77ec2b3b3a
Documentation: update committer_guidelines.rst ( #73782 )
...
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
0543916a86
Docsite: clarify a changelog entry format ( #73902 )
...
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
b57444af14
Rebased pr73824 ( #73934 )
...
Co-authored-by: Eugene <k.evgen61@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
4059b37ab1
Conscious language added to user guide, development guide, and Ansible community guide, ( #73574 )
...
* Added conscious language note to index pages of guides
4 years ago
7fb7d138fb
Update working group links for cloud collections ( #73471 )
4 years ago
599805e316
Introduce Ansible plugin in Jetbrains section of doc ( #72465 )
4 years ago
a5a0b8f0e7
Style guide edit to the tools page ( #72506 )
4 years ago
d18901dd4a
Update HTTP -> HTTPS ( #72244 )
...
Co-authored-by: Ronald Eddy Jr <ron@Ronalds-MacBook-Pro.local>
4 years ago
9382738f52
Update contributing_maintained_collections.rst ( #72178 )
...
##### SUMMARY
Adding Kubernetes.Core collection, editing vmware.vmware_rest a bit
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
4 years ago
e119c2d2bf
Add The Bullhorn to the community communication page ( #72125 )
...
Update documentation on communication channels for Ansible.
4 years ago
94522b7c10
Fix typos ( #71970 )
4 years ago
c1005147e0
doc: add vmware_rest_guidelines
...
Add the development guidelines for the vmware_rest collection.
4 years ago
4cb20dba97
Update index.rst ( #71887 )
...
* Update docs/docsite/rst/community/index.rst to include another link to the mailing lists list
4 years ago
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
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
29b20bd1b1
DOCS: Mentions ansible-base, adds collections pointers to Community and Dev Guides ( #71480 )
4 years ago
824cd4cbeb
Update ansible european IRC channel ( #71326 )
...
Signed-off-by: Rémi VERCHERE <remi@verchere.fr>
4 years ago
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
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
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
f1f782fc37
partial update of community docs to reflect collections transition ( #70488 )
4 years ago
edcd1a1a70
Doc: fix examples of changelog entries. ( #70551 )
4 years ago
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
647c6cd289
updates to ansible-maintained collections guidelines ( #70178 )
4 years ago
8ad46870a4
Update note about AWS collection test requirements in docs ( #70176 )
4 years ago
2609482975
How to contribute to Ansible maintained collections ( #69202 )
...
contributor info with HTML table
4 years ago
bfc510a0f8
Update other_tools_and_programs.rst ( #69499 )
5 years ago
925199511e
Add JetBrains platform tools ( #69478 )
5 years ago
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
09f86c1410
docs: communications update ( #69687 )
...
* add some more info on IRC support channels to docs
5 years ago
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
7e0794085e
add links to new docsites ( #69310 )
5 years ago
cfc9b4a1e2
Add Kubernetes Working Group to Communicating guide. ( #68028 )
5 years ago
f633772942
Update documenation contributions to reflect that some docs are in collections now ( #68264 )
5 years ago
ad8df69b58
docs/docsite/rst/: fix typos ( #67645 )
5 years ago
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
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
94e98d5369
remove toshio as release manager (boohoo) ( #64685 )
5 years ago
f264e9cfca
update backport instructions to use stable-2.9 ( #64168 )
5 years ago
c8315bfd60
Prefer https:// links in the docs site ( #62939 )
...
This is a follow-up of last year's 1a11cec
5 years ago
e7436e278f
Remove Latin phrases from the docs ( #62419 )
...
* add styleguide about avoiding use of latin words
5 years ago
2d19150757
Update mitogen link ( #62247 )
5 years ago
41055b5dc8
Proposals aren't really used much, delete it ( #61800 )
5 years ago
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
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
158f97bfb2
updates docs reqs to specify Pygments version, remove tornado ( #58007 )
5 years ago
e834cd7d41
updates reqs for building docs locally ( #57967 )
6 years ago
dfaa72297c
Fix an RST link to the changelog config in docs
6 years ago
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
5183f84016
📝 Mention the minumum cherry-picker version in doc ( #57139 )
6 years ago
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
6948e04276
Add myself to committer list. ( #56363 )
6 years ago
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
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
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
8e9a5c8de7
changes 'github' to 'GitHub' in community ( #51111 )
...
* changes 'github' to 'GitHub' in community
6 years ago
33b9c880a4
Consistent typesetting of "GitHub" ( #50929 )
6 years ago
52843fcabc
Making changes to the Community Guide index ( #49670 )
6 years ago
c3d579c52a
Docker & Remote Management Working Groups ( #49023 )
...
* Adds Docker & Remote Management Working Groups
6 years ago
3433ca286d
Docs reorg /community/index & /dev_guide/index ( #48734 )
...
* Improved community/index.rst makes it easier to find existing content
6 years ago
9ce9c9698a
committer_guidelines.rst: update core committers ( #48662 )
...
* committer_guidelines.rst: update core committers
* Another update
6 years ago
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
806442b3ec
Document the tests that are currently run on documentation pull requests. ( #48436 )
6 years ago
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
248827227a
Correcting syntax of PyYAML package ( #47987 )
6 years ago
f536944e3a
Molecule is now IRC: ansible-molecule ( #47860 )
6 years ago
4572d9ccd7
ansible-lint and molecule part of Red Hat ( #47826 )
6 years ago
e6d99cb2bf
Adding a link for PR info ( #47778 )
6 years ago
d189e58f63
Correct AWX community link ( #47742 )
6 years ago
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
166e84b9c4
Docs: No need to follow up on backport PRs ( #47616 )
...
Also tidy up `notes` section into a single box
6 years ago
4219d25fc7
Add docs about contributing to docs ( #46481 )
...
* adds page on community contributions to docs
6 years ago
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
f430f60541
Restore license agreement ( #45809 )
...
* adds page for CLA in community docs with links from dev and community docs
6 years ago
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
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
9a76441c02
rewrite of the developer guide, part 1 ( #45179 )
...
* rewrite of the developer guide, part 1
6 years ago
00e5123e4c
Update documentation based on 301 permanent redirects ( #43675 )
6 years ago
4a0b32083c
Fix link description typo in tools documentation ( #43828 )
6 years ago
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
321081c3b4
atom & yamllint ( #43498 )
...
* atom & yamllint
6 years ago
d79027b77f
Update with Emacs info ( #43450 )
...
* Update other_tools_and_programs with Emacs info
6 years ago
3ab9030f05
Document more tools ( #43053 )
...
* Document more tools
6 years ago
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
3e2a4f67cf
Update link to GitHub admin process ( #42364 )
6 years ago
Andrew Klychkov