Skip to content

Commit c41abec

Browse files
Andersson007oraNodsamccann
authored
Add ecosystem_project_resources.rst document (#2007)
* Add ecosystem_project_resources.rst document * Fix rst * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Don Naro <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Sandra McCann <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst Co-authored-by: Sandra McCann <[email protected]> * Update docs/docsite/rst/community/ecosystem_project_resources.rst --------- Co-authored-by: Don Naro <[email protected]> Co-authored-by: Sandra McCann <[email protected]>
1 parent 8c0f92f commit c41abec

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

docs/docsite/rst/community/advanced_index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44
Advanced Contributor Guide
55
**********************************************
66

7-
This guide focuses on contributors who are committers, GitHub admins, or release managers.
7+
This guide focuses on contributors who are committers, GitHub admins, release managers, or Ansible ecosystem project developers.
88

99
.. toctree::
1010
:maxdepth: 1
1111

1212
committer_guidelines
1313
release_managers
1414
github_admins
15+
ecosystem_project_resources
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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

Comments
 (0)