ansible collections guide: Align the project documentation with community standards

[Andersson007]

Dear Ansible ecosystem projects maintainers,

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

• README structure and content
• Docsite pages structure and content insufficiency, duplication or conflict with README and/or CONTRIBUTING

Missing information:

• Projects don't contain any contributor/testing guidelines (Contributor guide example),
• Project architecture information is missing (Architecture guide example),
• Project place in the ecosystem, its interplay with other projects. For example, a project can be a part of Ansible Controller but its purpose is not very clear.

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.

[Andersson007]

1. How about asking the community to help with this?
2. If no volunteers, i could take it
3. I opened the same issue for core, maybe other work should be done first, like its docs separation with collection guides

[samccann]

Brought up in DaWGs meeting. Next steps on this issue is to evaluate the state of the docs and where we are out of alignment. Then perhaps open new issues for each task to get community help.

[oraNod]

Brought up in DaWGs meeting. Next steps on this issue is to evaluate the state of the docs and where we are out of alignment. Then perhaps open new issues for each task to get community help.

my 2c is that we start with a tasklist in the issue here. that will show what work needs to be done to bring the project docsite into alignment before we spawn a bunch of new issues.