ansible / ansible/pylibssh

Align the project documentation with community standards

Open
#656 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Cython
Stars
79
Forks
47
Avg merge
1d 11h
Merged PRs (30d)
6

Description

##### 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](https://docs.ansible.com/ansible/latest/community/contributions_collections.html)),
- Project architecture information is missing ([Architecture guide example](https://ansible.readthedocs.io/projects/galaxy-ng/en/latest/dev/developer_guide/overview/)),
- 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](https://docs.ansible.com/ansible/devel/community/ecosystem_project_resources.html) 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](https://docs.ansible.com/ansible/devel/community/ecosystem_project_resources.html#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.

##### ISSUE TYPE
- Documentation Report

##### PYLIBSSH and LIBSSH VERSION

```paste below
N/A
```

Contributor guide

Open the contributing guide

Research direction

Review the README, CONTRIBUTING guidance, docsite pages, and the Ansible ecosystem project development resources, including the project-template. Compare pylibssh's documentation with the referenced standards and identify missing contributor/testing guidance, architecture information, and ecosystem context. Done means the documentation is restructured as needed and these gaps, duplications, and conflicts are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.