From ee684c7903f4f09b9b0f2bba445ca8096ecc4e89 Mon Sep 17 00:00:00 2001 From: Don Naro Date: Wed, 5 Jul 2023 11:34:45 +0100 Subject: [PATCH] issue #115 maintainers template --- build.py | 1 + data/links.yaml | 20 ------------ data/maintainers.yaml | 61 +++++++++++++++++++++++++++++++++++ data/pages.yaml | 32 ++---------------- templates/index.html | 6 ++-- templates/maintainers.html | 66 +++++++++----------------------------- 6 files changed, 83 insertions(+), 103 deletions(-) create mode 100644 data/maintainers.yaml diff --git a/build.py b/build.py index d6caf56..08cf601 100644 --- a/build.py +++ b/build.py @@ -11,6 +11,7 @@ def data(): "base": load(open("data/base.yaml"), Loader=Loader), "ecosystem": load(open("data/ecosystem.yaml"), Loader=Loader), "links": load(open("data/links.yaml"), Loader=Loader), + "maintainers": load(open("data/maintainers.yaml"), Loader=Loader), "pages": load(open("data/pages.yaml"), Loader=Loader), "platform": load(open("data/platform.yaml"), Loader=Loader), "controller_archive": load(open("data/controller_archive.yaml"), Loader=Loader), diff --git a/data/links.yaml b/data/links.yaml index ae323e5..e5014bd 100644 --- a/data/links.yaml +++ b/data/links.yaml @@ -25,8 +25,6 @@ quicklinks: developing_modules: "https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html" python_three: "https://docs.ansible.com/ansible/latest/dev_guide/developing_python_3.html" python_api: "https://docs.ansible.com/ansible/latest/dev_guide/developing_api.html" - maintainer_news: "https://github.com/ansible-collections/news-for-maintainers/issues" - community_topics: "https://github.com/ansible-community/community-topics/issues" # Novice actions novice: learn: "https://docs.ansible.com/ansible/latest/index.html" @@ -85,24 +83,6 @@ developer: gh_actions: "" troubleshoot: "" request_inclusion: "https://github.com/ansible-collections/ansible-inclusion" -# Community maintainer actions -maintainer: - learn: - guidelines: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html" - backports: "https://docs.ansible.com/ansible/latest/community/maintainers_workflow.html#backporting" - release: "https://docs.ansible.com/ansible/latest/community/collection_contributors/collection_releasing.html#releasing" - documentation: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#maintaining-good-collection-documentation" - build_community: - grow_community: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#expanding-the-collection-community" - contributor_paths: "https://docs.ansible.com/ansible/latest/community/contributor_path.html" - documentation: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#maintaining-good-collection-documentation" - collection_inclusion: - process: "https://docs.ansible.com/ansible/devel/community/steering/community_steering_committee.html#collection-inclusion-requests-workflow" - review: "https://github.com/ansible-collections/ansible-inclusion/blob/main/README.md#review-process" - submit: "https://github.com/ansible-collections/ansible-inclusion/blob/main/README.md#submission-process" - participate: - community_topics: "https://github.com/ansible-community/community-topics/issues" - join: "https://docs.ansible.com/ansible/latest/community/contributor_path.html#become-a-steering-committee-member" # Ansible community community: collaborate: diff --git a/data/maintainers.yaml b/data/maintainers.yaml new file mode 100644 index 0000000..301a22d --- /dev/null +++ b/data/maintainers.yaml @@ -0,0 +1,61 @@ +# Quicklinks for Ansible community maintainers +quicklinks: + maintainer_news: + label: News for maintainers + link: "https://github.com/ansible-collections/news-for-maintainers/issues" + community_topics: + label: Community topics + link: "https://github.com/ansible-community/community-topics/issues" + package_inclusion: + label: Package inclusion requests + link: "https://docs.ansible.com/ansible/devel/community/steering/community_steering_committee.html#collection-inclusion-requests-workflow" +# Milestones in the Ansible community maintainer journey +milestones: + learn: + heading: Learn about community maintainer responsibilities + actions: + guidelines: + label: Review community maintainer responsibilities + link: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html" + backports: + label: Backport merged pull requests to stable branches + link: "https://docs.ansible.com/ansible/latest/community/maintainers_workflow.html#backporting" + release: + label: Regularly release stable versions + link: "https://docs.ansible.com/ansible/latest/community/collection_contributors/collection_releasing.html#releasing" + documentation: + label: Look after collection documentation + link: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#maintaining-good-collection-documentation" + build_community: + heading: Expand community around a collection + actions: + grow_community: + label: Explore ways to grow community + link: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#expanding-the-collection-community" + documentation: + label: Maintain good contributor documentation + link: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#maintaining-good-collection-documentation" + contributor_paths: + label: Understand Ansible contributor paths + link: "https://docs.ansible.com/ansible/latest/community/contributor_path.html" + collection_inclusion: + heading: Get collections included in the Ansible package + actions: + process: + label: Understand the inclusion process + link: "https://docs.ansible.com/ansible/devel/community/steering/community_steering_committee.html#collection-inclusion-requests-workflow" + review: + label: Review other inclusion requests + link: "https://github.com/ansible-collections/ansible-inclusion/blob/main/README.md#review-process" + submit: + label: Submit your collection for inclusion + link: "https://github.com/ansible-collections/ansible-inclusion/blob/main/README.md#submission-process" + participate: + heading: Participate in cross-project governance + actions: + community_topics: + label: Discuss and vote on community topics + link: "https://github.com/ansible-community/community-topics/issues" + join: + label: Join the Ansible community steering committee + link: "https://docs.ansible.com/ansible/latest/community/contributor_path.html#become-a-steering-committee-member" diff --git a/data/pages.yaml b/data/pages.yaml index 7369450..08c9369 100644 --- a/data/pages.yaml +++ b/data/pages.yaml @@ -36,9 +36,6 @@ quicklinks: developing_modules: Developing modules python_three: Ansible and Python 3 python_api: Python API - maintainer_news: News for maintainers - community_topics: Community topics - package_inclusion: Package inclusion requests # Actions for novice journeys novice: learn: Understand the fundamentals of Ansible automation @@ -131,35 +128,10 @@ developer: gh_actions: Use GitHub actions to set up testing workflows troubleshoot: Troubleshoot collections with ansible-navigator request_inclusion: Request a collection be added to the Ansible package -# Actions for community maintainer journeys -maintainer: +# Title and intro for maintainers.html +maintainers: title: Maintainers intro: Ansible community maintainers are trusted contributors who oversee project lifecycle and overall health. - milestone: - learn: Learn about community maintainer responsibilities - build_community: Expand community around a collection - collection_inclusion: Get collections included in the Ansible package - participate: Participate in cross-project governance - learn: - intro: Interested in becoming a community maintainer? Find out what's involved. - guidelines: Review community maintainer responsibilities - backports: Backport merged pull requests to stable branches - release: Regularly release stable versions - documentation: Look after collection documentation - build_community: - intro: Community maintainers play a special role to enable and encourage contributors. - grow_community: Explore ways to grow community - documentation: Maintain good contributor documentation - contributor_paths: Understand Ansible contributor paths - collection_inclusion: - intro: Satisfy requirements to get collections included in the Ansible package. - process: Understand the inclusion process - review: Review other inclusion requests - submit: Submit your collection for inclusion - participate: - intro: Get involved in higher-level decision processes that guide the broader community. - community_topics: Discuss and vote on community topics - join: Join the Ansible community steering committee # Ansible core core: title: Ansible Core diff --git a/templates/index.html b/templates/index.html index a04315e..aa56d2f 100644 --- a/templates/index.html +++ b/templates/index.html @@ -78,9 +78,9 @@

{{ pages.index.maintainer_heading }}

- {{ pages.maintainer.learn.guidelines }} - {{ pages.maintainer.build_community.contributor_paths }} - {{ pages.maintainer.build_community.grow_community }} + {{ maintainers.milestones.learn.actions.guidelines.label }} + {{ maintainers.milestones.build_community.actions.contributor_paths.label }} + {{ maintainers.milestones.build_community.actions.grow_community.label }}  {{ pages.index.maintainer_resources_action }}
diff --git a/templates/maintainers.html b/templates/maintainers.html index 0b7a902..bcdbb9f 100644 --- a/templates/maintainers.html +++ b/templates/maintainers.html @@ -1,15 +1,11 @@ -{% extends "_base.html" %} -{% block body %} +{% extends "_base.html" %} {% block body %}
-
-
- +
+
-

{{ pages.maintainer.title }}

-

{{ pages.maintainer.intro }}

+

{{ pages.maintainers.title }}

+

{{ pages.maintainers.intro }}

@@ -18,59 +14,29 @@

{{ pages.maintainer.title }}

{{ pages.quicklinks.heading }}

+ + {% for key, value in maintainers.milestones.items() -%}
-

{{ pages.maintainer.milestone.learn }}

- -
- {{ pages.maintainer.learn.guidelines }} - {{ pages.maintainer.learn.backports }} - {{ pages.maintainer.learn.release }} - {{ pages.maintainer.learn.documentation }} -
-
-
-

{{ pages.maintainer.milestone.build_community }}

- -
- {{ pages.maintainer.build_community.grow_community }} - {{ pages.maintainer.build_community.documentation }} - {{ pages.maintainer.build_community.contributor_paths }} -
-
-
-

{{ pages.maintainer.milestone.collection_inclusion }}

- -
- {{ pages.maintainer.collection_inclusion.process }} - {{ pages.maintainer.collection_inclusion.review }} - {{ pages.maintainer.collection_inclusion.submit }} -
-
-
-

{{ pages.maintainer.milestone.participate }}

- +

{{ value.heading }}

- {{ pages.maintainer.participate.community_topics }} - {{ pages.maintainer.participate.join }} + {%- for action_key, action_value in value.actions.items() %} + {{ action_value.label }} + {%- endfor %}
+ {% endfor -%} +