|
| 1 | +.. _ecosystem_project_dev_resources: |
| 2 | + |
| 3 | +*********************************************** |
| 4 | +Ansible Ecosystem Project Development Resources |
| 5 | +*********************************************** |
| 6 | + |
| 7 | +This document lists resources to help contributors interested in developing a community project in the `Ansible ecosystem <https://docs.ansible.com/ecosystem.html>`_. |
| 8 | + |
| 9 | +.. note:: |
| 10 | + |
| 11 | + Any improvements to the resources listed in this document or to the document itself are very welcome! Please submit an issue or pull request in the corresponding GitHub repository. |
| 12 | + |
| 13 | +.. _onboarding_toolkit: |
| 14 | + |
| 15 | +Onboarding toolkit |
| 16 | +================== |
| 17 | + |
| 18 | +The `Ansible Onboarding toolkit <https://ansible.readthedocs.io/projects/project-onboarding/en/latest/>`_ provides guidelines on setting up GitHub repositories for new projects as well as the type of documentation your project should include. |
| 19 | + |
| 20 | +Despite being originally developed for Ansible ecosystem projects under the ``ansible-community`` GitHub organization, everyone is welcome to use the onboarding toolkit. |
| 21 | + |
| 22 | +Project template |
| 23 | +================ |
| 24 | + |
| 25 | +The `Ansible project-template <https://github.com/ansible-community/project-template>`_ is a GitHub repository template for Ansible ecosystem projects that contains: |
| 26 | + |
| 27 | +* Files normally present in every repository such as README, license, code of conduct, and so on. |
| 28 | +* A docsite template that you are encouraged to use with your project to provide a consistent experience across the Ansible project ecosystem. |
| 29 | + |
| 30 | +Please take a look at the `docsite <https://ansible.readthedocs.io/projects/ansible-project-template/en/latest/>`_ built from the project-template to see it in action. |
| 31 | + |
| 32 | +You are welcome to take the template, fill in your project-specific information, build it using `Sphinx <https://www.sphinx-doc.org/en/master/>`_, and then publish it. |
| 33 | + |
| 34 | +Even if your project is not new and already has documentation, we recommend you take a look at the template and check if there is anything missed in documentation for your project users, contributors, and maintainers. |
| 35 | + |
| 36 | +List of community-curated projects |
| 37 | +================================== |
| 38 | + |
| 39 | +Whether your project repository is under the ``ansible-community`` GitHub organization or under your own one, you are welcome to include your project in the `Awesome Ansible list <https://github.com/ansible-community/awesome-ansible/blob/main/README.md>`_. |
| 40 | + |
| 41 | +Before letting the community know about your shiny project by adding it to the list, make sure it satisfies the standards explained in the :ref:`onboarding_toolkit` to provide the best user and contributor experience. |
0 commit comments