diff --git a/docs/docsite/rst/community/advanced_index.rst b/docs/docsite/rst/community/advanced_index.rst index b07b72ff17a..6ccc9269b90 100644 --- a/docs/docsite/rst/community/advanced_index.rst +++ b/docs/docsite/rst/community/advanced_index.rst @@ -4,7 +4,7 @@ Advanced Contributor Guide ********************************************** -This guide focuses on contributors who are committers, GitHub admins, or release managers. +This guide focuses on contributors who are committers, GitHub admins, release managers, or Ansible ecosystem project developers. .. toctree:: :maxdepth: 1 @@ -12,3 +12,4 @@ This guide focuses on contributors who are committers, GitHub admins, or release committer_guidelines release_managers github_admins + ecosystem_project_resources diff --git a/docs/docsite/rst/community/ecosystem_project_resources.rst b/docs/docsite/rst/community/ecosystem_project_resources.rst new file mode 100644 index 00000000000..e9f681074a3 --- /dev/null +++ b/docs/docsite/rst/community/ecosystem_project_resources.rst @@ -0,0 +1,41 @@ +.. _ecosystem_project_dev_resources: + +*********************************************** +Ansible Ecosystem Project Development Resources +*********************************************** + +This document lists resources to help contributors interested in developing a community project in the `Ansible ecosystem `_. + +.. note:: + + 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. + +.. _onboarding_toolkit: + +Onboarding toolkit +================== + +The `Ansible Onboarding toolkit `_ provides guidelines on setting up GitHub repositories for new projects as well as the type of documentation your project should include. + +Despite being originally developed for Ansible ecosystem projects under the ``ansible-community`` GitHub organization, everyone is welcome to use the onboarding toolkit. + +Project template +================ + +The `Ansible project-template `_ is a GitHub repository template for Ansible ecosystem projects that contains: + +* Files normally present in every repository such as README, license, code of conduct, and so on. +* A docsite template that you are encouraged to use with your project to provide a consistent experience across the Ansible project ecosystem. + +Please take a look at the `docsite `_ built from the project-template to see it in action. + +You are welcome to take the template, fill in your project-specific information, build it using `Sphinx `_, and then publish it. + +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. + +List of community-curated projects +================================== + +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 `_. + +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.