ansible / ansible-dev-tools

Ansible automation developer tools
https://ansible.readthedocs.io/projects/dev-tools/
GNU General Public License v3.0
85 stars 29 forks source link

Align the project documentation with community standards #473

Open Andersson007 opened 2 weeks ago

Andersson007 commented 2 weeks ago

Dear Ansible ecosystem projects maintainers,

While reviewing all the ecosystem projects, we've noticed inconsistency/insufficiency in documentation in many of them. Particularly:

Missing information:

A new document called Ansible ecosystem project development resources has been recently added to docs.ansible.com. It lists resources to help contributors interested in developing a community project in Ansible ecosystem including a reference to the project-template repository and a docsite built from it. The templates it provides contains all documentation topics that need to be covered in any mature OSS community project.

Please review the document and ensure your projects align by adding the missing information as well as restructuring your docs as needed.

Let's make our projects community friendly. Any improvements/feedback is appreciated.