Skip to content
This repository has been archived by the owner on May 14, 2024. It is now read-only.

What tools should we include on the Tools and programs page in docs? #220

Closed
samccann opened this issue Mar 28, 2023 · 10 comments
Closed

What tools should we include on the Tools and programs page in docs? #220

samccann opened this issue Mar 28, 2023 · 10 comments

Comments

@samccann
Copy link

Summary

We have the following page in docs - https://docs.ansible.com/ansible/latest/community/other_tools_and_programs.html

Which lists things like editors that have ansible extensions, and then we have another list of tools etc. Today, we haven't set a guideline on what is included on that page.

So, should we :

  1. Only list projects that the community is maintaining (things like vscode plugins and antsibull-docs etc)
  2. List projects that community members are directly involved in, even though not covered as part of the Ansible community directly.
  3. List projects that the community verifies are useful and well-maintained.
  4. List anything anyone opens a PR to add :-)
@felixfontein
Copy link
Contributor

Since that topic came up in today's DaWGs meeting I decided to create a PR for adding antsbull-changelog and antsibull-docs there (ansible/ansible#80340), so we have at least one concrete example ;-)

@felixfontein
Copy link
Contributor

Only list projects that the community is maintaining (things like vscode plugins and antsibull-docs etc)

How exactly is this defined? Should these be projects that live in one of the ansible GH organizations (gh.com/ansible-community, etc.)? Or are (some) projects outside of these orgs (or even outside GitHub) also covered?

@samccann
Copy link
Author

Only list projects that the community is maintaining (things like vscode plugins and antsibull-docs etc)

How exactly is this defined? Should these be projects that live in one of the ansible GH organizations (gh.com/ansible-community, etc.)? Or are (some) projects outside of these orgs (or even outside GitHub) also covered?

If we say 'community-maintained only' then yes, I think it would live in one of the Ansible github orgs.

@gotmax23
Copy link
Contributor

I agree with #2 or #3. I feel queasy about limiting this to certain Github organizations. Projects shouldn't be required to use Github or be under a specific umbrella. For sure, projects should be related to ansible, open source, useful to the community at large, and maintained.

@acozine
Copy link
Contributor

acozine commented Apr 4, 2023

I'd vote for #3. I'd rather spend time confirming that a tool is useful than figuring out who maintains it and if that person is part of the Ansible community.

@samccann
Copy link
Author

samccann commented Apr 5, 2023

Community WG feedback:

General guideline - use https://github.com/ansible-community/awesome-ansible as the full curated list. Use this page only for the tools the community maintains. Anything valid we remove from this docs page should be added to awesome ansible.

Other feedback:

  • return the list to alphabetical order
    add pycharm link
  • remove Jetbrains as not actively maintained
  • add toc to top of page
  • add disclaimer to all tools etc that aren't maintained by the community (vscode, ara, etc)
  • update link to awesome ansible to -https://github.com/ansible-community/awesome-ansible

@samccann
Copy link
Author

samccann commented Apr 5, 2023

Also remove https://ansible.sivel.net/pr/byfile.html and check which Jetbrains is still active vs MSDehghan/AnsiblePlugin#22

@felixfontein
Copy link
Contributor

I like the suggestion to simply point to https://github.com/ansible-community/awesome-ansible instead of having another list of stuff that needs to be curated / updated.

Also we should contact the creator of https://github.com/jdauphant/awesome-ansible whether they want to collaborate on https://github.com/ansible-community/awesome-ansible instead of having a separate list.

@ssbarnea
Copy link
Member

ssbarnea commented Apr 6, 2023

awesome ansible is awesome but I noted that is manually made, see ansible-community/awesome-ansible#86

@samccann
Copy link
Author

Moved this to an issue in ansible/ansible. Thanks everyone!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants