Skip to content

Commit fd41e24

Browse files
[Needs SC review] community/other_tools_and_programs.rst: update (ansible#2284)
* community/other_tools_and_programs.rst: update * Add a link to Awesome Ansible for editors info * Fix * Update docs/docsite/rst/community/other_tools_and_programs.rst Co-authored-by: Sandra McCann <[email protected]> * Add SC as codeowners * Fix --------- Co-authored-by: Sandra McCann <[email protected]>
1 parent cff89e9 commit fd41e24

File tree

2 files changed

+10
-67
lines changed

2 files changed

+10
-67
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @ansible/steering-committee
22
/docs/docsite/rst/community/steering/* @ansible/steering-committee
33
/docs/docsite/rst/roadmap/COLLECTIONS_*.rst @ansible/steering-committee
4+
/docs/docsite/rst/community/other_tools_and_programs.rst @ansible/steering-committee
45
/MAINTAINERS.md @ansible/community-docs-maintainers
56
# DCO and COPYING need approval from the Red Hat open-source legal team
67
# See the maintainers guide for details

docs/docsite/rst/community/other_tools_and_programs.rst

Lines changed: 9 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -9,53 +9,15 @@ Other Tools and Programs
99

1010
The Ansible community uses a range of tools for working with the Ansible project. This is a list of some of the most popular of these tools.
1111

12-
If you know of any other tools that should be added, this list can be updated by clicking "Edit on GitHub" on the top right of this page.
13-
12+
If you know of any other tools that should be added, open a PR against the `Awesome Ansible repository <https://github.com/ansible-community/awesome-ansible>`_.
1413

1514
Popular editors
1615
===============
1716

17+
Text editors
18+
------------
1819

19-
Emacs
20-
-----
21-
22-
A free, open-source text editor and IDE that supports auto-indentation, syntax highlighting and a built in terminal shell (among other things).
23-
24-
* `yaml-mode <https://github.com/yoshiki/yaml-mode>`_ - YAML highlighting and syntax checking.
25-
* `jinja2-mode <https://github.com/paradoxxxzero/jinja2-mode>`_ - Jinja2 highlighting and syntax checking.
26-
* `magit-mode <https://github.com/magit/magit>`_ - Git porcelain within Emacs.
27-
* `lsp-mode <https://emacs-lsp.github.io/lsp-mode/page/lsp-ansible/>`_ - Ansible syntax highlighting, auto-completion and diagnostics.
28-
* `flymake-ansible-lint <https://github.com/jamescherti/flymake-ansible-lint.el>`_ - Ansible Lint integration with automatic/continuous annotation of errors, warnings, and info while editing.
29-
30-
31-
PyCharm
32-
-------
33-
34-
A full IDE for Python software development. It ships with everything you need to write Python scripts and applications, including support for YAML syntax highlighting. It can be a very useful tool if you write modules and submit code for Ansible. Can be used to debug ``ansible-core``. For more information, see `PyCharm <https://www.jetbrains.com/pycharm/>`_. Useful plugins include:
35-
36-
* `Ansible Lint <https://plugins.jetbrains.com/plugin/20905-ansible-lint>`_ - Ansible Lint integration with automatic/continuous annotation of errors, warnings, and info while editing.
37-
* `Ansible Vault Integration <https://plugins.jetbrains.com/plugin/14353-ansible-vault-integration>`_ - Integrate the ansible vault directly into IntelliJ IDEA with context actions for vaulting and unvaulting secrets.
38-
39-
Sublime
40-
-------
41-
42-
A closed-source, subscription GUI text editor. You can customize the GUI with themes and install packages for language highlighting and other refinements. You can install Sublime on Linux, macOS and Windows. Useful Sublime plugins include:
43-
44-
* `GitGutter <https://packagecontrol.io/packages/GitGutter>`_ - shows information about files in a Git repository.
45-
* `SideBarEnhancements <https://packagecontrol.io/packages/SideBarEnhancements>`_ - provides enhancements to the operations on Sidebar of Files and Folders.
46-
* `Sublime Linter <https://packagecontrol.io/packages/SublimeLinter>`_ - a code-linting framework for Sublime Text 3.
47-
* `Pretty YAML <https://packagecontrol.io/packages/Pretty%20YAML>`_ - prettifies YAML for Sublime Text 2 and 3.
48-
* `Yamllint <https://packagecontrol.io/packages/SublimeLinter-contrib-yamllint>`_ - a Sublime wrapper around yamllint.
49-
50-
51-
vim
52-
---
53-
54-
An open-source, free command-line text editor. Useful vim plugins include:
55-
56-
* `Ansible vim <https://github.com/pearofducks/ansible-vim>`_ - vim syntax plugin for Ansible 2.x, it supports YAML playbooks, Jinja2 templates, and Ansible's hosts files.
57-
* `Ansible vim and neovim plugin <https://www.npmjs.com/package/@yaegassy/coc-ansible>`_ - vim plugin (lsp client) for Ansible, it supports autocompletion, syntax highlighting, hover, diagnostics, and goto support.
58-
20+
There are popular open-source editors like Vim or Emacs that support YAML, Jinja, and specifically Ansible through corresponding plugins. Refer to `Awesome Ansible Editors List <https://github.com/ansible-community/awesome-ansible?tab=readme-ov-file#editor-and-ide-integrations>`_ for more information.
5921

6022
Visual studio code
6123
------------------
@@ -70,42 +32,22 @@ An open-source, free GUI text editor created and maintained by Microsoft. Useful
7032

7133
the Visual Studio Code Ansible extension is maintained by the Ansible community and Red Hat.
7234

73-
74-
75-
76-
Development tools
77-
=================
78-
79-
Finding related issues and PRs
80-
------------------------------
81-
82-
There are various ways to find existing issues and pull requests (PRs)
83-
84-
- `jctanner's Ansible Tools <https://github.com/jctanner/ansible-tools>`_ - miscellaneous collection of useful helper scripts for Ansible development.
85-
8635
.. _validate-playbook-tools:
8736

88-
8937
Tools for validating playbooks
9038
==============================
9139

9240
- `Ansible Lint <https://docs.ansible.com/ansible-lint/index.html>`__ - a highly configurable linter for Ansible playbooks.
93-
- `Ansible Review <https://github.com/willthames/ansible-review>`_ - an extension of Ansible Lint designed for code review.
9441
- `Molecule <https://ansible.readthedocs.io/projects/molecule/>`_ - a testing framework for Ansible plays and roles.
9542
- `yamllint <https://yamllint.readthedocs.io/en/stable/>`__ - a command-line utility to check syntax validity including key repetition and indentation issues.
9643

44+
Collection development tools
45+
============================
9746

47+
- `antsibull-changelog <https://github.com/ansible-community/antsibull-changelog>`_ - a changelog generator for Ansible collections.
48+
- `antsibull-docs <https://github.com/ansible-community/antsibull-docs>`_ - a docsite generator and documentation validator for Ansible collections.
9849

9950
Other tools
10051
===========
10152

102-
- `Ansible Inventory Grapher <https://github.com/willthames/ansible-inventory-grapher>`_ - visually displays inventory inheritance hierarchies and at what level a variable is defined in inventory.
103-
- `Ansible Silo <https://github.com/groupon/ansible-silo>`_ - a self-contained Ansible environment by Docker.
104-
- `Ansigenome <https://github.com/nickjj/ansigenome>`_ - a command line tool designed to help you manage your Ansible roles.
105-
- `antsibull-changelog <https://github.com/ansible-community/antsibull-changelog>`_ - a changelog generator for Ansible collections.
106-
- `antsibull-docs <https://github.com/ansible-community/antsibull-docs>`_ - generates docsites for collections and can validate collection documentation.
107-
- `ARA <https://github.com/ansible-community/ara>`_ - ARA Records Ansible playbooks and makes them easier to understand and troubleshoot with a reporting API, UI and CLI.
108-
- `Awesome Ansible <https://github.com/ansible-community/awesome-ansible>`_ - a collaboratively curated list of awesome Ansible resources.
109-
- `nanvault <https://github.com/marcobellaccini/nanvault>`_ - a standalone tool to encrypt and decrypt files in the Ansible Vault format, featuring UNIX-style composability.
110-
- `OpsTools-ansible <https://github.com/centos-opstools/opstools-ansible>`_ - uses Ansible to configure an environment that provides the support of `OpsTools <https://wiki.centos.org/SpecialInterestGroup/OpsTools>`_, namely centralized logging and analysis, availability monitoring, and performance monitoring.
111-
- `ansibledb <https://github.com/nbentoumi/ansibledb>`_ - Flask API server that uses MongoDB to store Ansible reports and facts. Along with different query capabilities, this tool provides a web UI for viewing Ansible reports, facts, and logs.
53+
Refer to `Awesome Ansible Tools List <https://github.com/ansible-community/awesome-ansible#tools>`_, a community-curated list of awesome Ansible resources.

0 commit comments

Comments
 (0)