Description
Please confirm the following
- I agree to follow this project's code of conduct.
- I have checked the current issues for duplicates.
- I understand that EDA-Controller is open source software provided for free and that I might not receive a timely response.
Feature type
Enhancement to Existing Feature
Feature Summary
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.
Steps to reproduce
n/a
Current results
n/a
Sugested feature result
n/a
Additional information
No response