From 798349d1d6ec90d0fdf395b87be6755b37b2e6ad Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 18 Dec 2024 15:30:56 +0100 Subject: [PATCH] [Needs SC review] community/other_tools_and_programs.rst: update (#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 * Add SC as codeowners * Fix --------- Co-authored-by: Sandra McCann (cherry picked from commit fd41e247016bb38cb970ee2c6120a8f08ec2813b) --- .github/CODEOWNERS | 6 -- .../community/other_tools_and_programs.rst | 77 +++---------------- 2 files changed, 9 insertions(+), 74 deletions(-) delete mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index 44dd3ceff9..0000000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,6 +0,0 @@ -/docs/docsite/rst/community/collection_contributors/collection_requirements.rst @ansible/steering-committee -/docs/docsite/rst/community/steering/* @ansible/steering-committee -/docs/docsite/rst/roadmap/COLLECTIONS_*.rst @ansible/steering-committee -# DCO and COPYING need approval from the Red Hat open-source legal team -/DCO @ansible/community-docs-maintainers -/COPYING @ansible/community-docs-maintainers diff --git a/docs/docsite/rst/community/other_tools_and_programs.rst b/docs/docsite/rst/community/other_tools_and_programs.rst index 06611c0d15..91dac557db 100644 --- a/docs/docsite/rst/community/other_tools_and_programs.rst +++ b/docs/docsite/rst/community/other_tools_and_programs.rst @@ -9,53 +9,15 @@ Other Tools and Programs 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. -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. - +If you know of any other tools that should be added, open a PR against the `Awesome Ansible repository `_. Popular editors =============== +Text editors +------------ -Emacs ------ - -A free, open-source text editor and IDE that supports auto-indentation, syntax highlighting and a built in terminal shell (among other things). - -* `yaml-mode `_ - YAML highlighting and syntax checking. -* `jinja2-mode `_ - Jinja2 highlighting and syntax checking. -* `magit-mode `_ - Git porcelain within Emacs. -* `lsp-mode `_ - Ansible syntax highlighting, auto-completion and diagnostics. -* `flymake-ansible-lint `_ - Ansible Lint integration with automatic/continuous annotation of errors, warnings, and info while editing. - - -PyCharm -------- - -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 `_. Useful plugins include: - -* `Ansible Lint `_ - Ansible Lint integration with automatic/continuous annotation of errors, warnings, and info while editing. -* `Ansible Vault Integration `_ - Integrate the ansible vault directly into IntelliJ IDEA with context actions for vaulting and unvaulting secrets. - -Sublime -------- - -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: - -* `GitGutter `_ - shows information about files in a Git repository. -* `SideBarEnhancements `_ - provides enhancements to the operations on Sidebar of Files and Folders. -* `Sublime Linter `_ - a code-linting framework for Sublime Text 3. -* `Pretty YAML `_ - prettifies YAML for Sublime Text 2 and 3. -* `Yamllint `_ - a Sublime wrapper around yamllint. - - -vim ---- - -An open-source, free command-line text editor. Useful vim plugins include: - -* `Ansible vim `_ - vim syntax plugin for Ansible 2.x, it supports YAML playbooks, Jinja2 templates, and Ansible's hosts files. -* `Ansible vim and neovim plugin `_ - vim plugin (lsp client) for Ansible, it supports autocompletion, syntax highlighting, hover, diagnostics, and goto support. - +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 `_ for more information. Visual studio code ------------------ @@ -70,43 +32,22 @@ An open-source, free GUI text editor created and maintained by Microsoft. Useful the Visual Studio Code Ansible extension is maintained by the Ansible community and Red Hat. - - - -Development tools -================= - -Finding related issues and PRs ------------------------------- - -There are various ways to find existing issues and pull requests (PRs) - -- `jctanner's Ansible Tools `_ - miscellaneous collection of useful helper scripts for Ansible development. - .. _validate-playbook-tools: - Tools for validating playbooks ============================== - `Ansible Lint `__ - a highly configurable linter for Ansible playbooks. -- `Ansible Review `_ - an extension of Ansible Lint designed for code review. - `Molecule `_ - a testing framework for Ansible plays and roles. - `yamllint `__ - a command-line utility to check syntax validity including key repetition and indentation issues. +Collection development tools +============================ +- `antsibull-changelog `_ - a changelog generator for Ansible collections. +- `antsibull-docs `_ - a docsite generator and documentation validator for Ansible collections. Other tools =========== -- `Ansible Inventory Grapher `_ - visually displays inventory inheritance hierarchies and at what level a variable is defined in inventory. -- `Ansible Shell `_ - an interactive shell for Ansible with built-in tab completion for all the modules. -- `Ansible Silo `_ - a self-contained Ansible environment by Docker. -- `Ansigenome `_ - a command line tool designed to help you manage your Ansible roles. -- `antsibull-changelog `_ - a changelog generator for Ansible collections. -- `antsibull-docs `_ - generates docsites for collections and can validate collection documentation. -- `ARA `_ - ARA Records Ansible playbooks and makes them easier to understand and troubleshoot with a reporting API, UI and CLI. -- `Awesome Ansible `_ - a collaboratively curated list of awesome Ansible resources. -- `nanvault `_ - a standalone tool to encrypt and decrypt files in the Ansible Vault format, featuring UNIX-style composability. -- `OpsTools-ansible `_ - uses Ansible to configure an environment that provides the support of `OpsTools `_, namely centralized logging and analysis, availability monitoring, and performance monitoring. -- `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. +Refer to `Awesome Ansible Tools List `_, a community-curated list of awesome Ansible resources.