From 3968c492d68808f11497a1ce82c8535f36de5fcd Mon Sep 17 00:00:00 2001 From: Don Naro Date: Fri, 10 Mar 2023 10:19:31 +0000 Subject: [PATCH] add maintainer journeys (#39) --- data/links.yaml | 19 +++++++++++++---- data/pages.yaml | 35 ++++++++++++++++++++++++++---- templates/index.html | 6 +++--- templates/maintainer.html | 45 ++++++++++++++++++++++++++++++++++++++- 4 files changed, 93 insertions(+), 12 deletions(-) diff --git a/data/links.yaml b/data/links.yaml index 02c8842..76f41a6 100644 --- a/data/links.yaml +++ b/data/links.yaml @@ -16,10 +16,6 @@ user_actions: automate: "https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_intro.html#playbook-syntax" evaluate_plugins: "https://docs.ansible.com/ansible/latest/module_plugin_guide/modules_intro.html" build_inventory: "https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html" -maintainer_actions: - overview: "https://docs.ansible.com/ansible/latest/community/contributor_path.html" - learn: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html" - join: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#weekly-community-matrix-irc-meetings" project_doc_home: als: "https://als.readthedocs.io/en/latest/" awx: "https://github.com/ansible/awx" @@ -63,3 +59,18 @@ developer: gh_actions: "" troubleshoot: "" request_inclusion: "https://github.com/ansible-collections/ansible-inclusion" +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: + communication: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#weekly-community-matrix-irc-meetings" + contributor_paths: "https://docs.ansible.com/ansible/latest/community/contributor_path.html" + encourage: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#encouraging-new-contributors" + collection_inclusion: + process: "https://github.com/ansible-collections/ansible-inclusion/blob/main/README.md#submission-process" + review: "https://github.com/ansible-collections/ansible-inclusion/blob/main/README.md#review-process" + participate: + join: "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 40e15d3..e35bb80 100644 --- a/data/pages.yaml +++ b/data/pages.yaml @@ -37,10 +37,6 @@ index: # Community maintainer maintainer_heading: Community maintainers maintainer_body: Ansible maintainers are responsible for the ongoing quality of Ansible projects and collections and play a vital role in guiding the direction of the wider community. - maintainer_actions: - overview: Understand Ansible contributor paths - learn: Learn about community maintainer responsibilities - join: Join or start a discussion that interests you maintainer_resources_heading: Community maintainer resources maintainer_resources_body: Handle project lifecycles, ensure the health of collections, join the Ansible steering committee, and more. maintainer_resources_action: Find more resources for Ansible community maintainers @@ -88,6 +84,37 @@ 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 +# Resources for community maintainer journeys. +maintainer: + title: Ansible community maintainers + intro: 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. + label: Button group that links to Ansible community maintainer documentation. + 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. + label: Button group that links to base Ansible community maintainer documentation. + communication: Join or start a community discussion + contributor_paths: Understand Ansible contributor paths + encourage: Attract and mentor new contributors + collection_inclusion: + intro: Satisfy requirements to get collections included in the Ansible package. + label: Button group that links to Ansible community maintainer documentation. + process: Understand the inclusion process + review: Go through inclusion review cycles + participate: + intro: Get involved in higher-level decision processes that guide the broader community. + label: Button group that links to Ansible community maintainer documentation. + join: Join the Ansible steering committee # Labels provide meaningful descriptions of elements for accessibility purposes. labels: button_group: Button group that links to Ansible community documentation. \ No newline at end of file diff --git a/templates/index.html b/templates/index.html index a04a7b3..3c7c786 100644 --- a/templates/index.html +++ b/templates/index.html @@ -75,9 +75,9 @@
{{ pages.index.developer_resources_heading }}
{{ pages.index.maintainer_heading }}

{{ pages.index.maintainer_body }}

- {{ pages.index.maintainer_actions.overview}} - {{ pages.index.maintainer_actions.learn }} - {{ pages.index.maintainer_actions.join }} + {{ pages.maintainer.learn.guidelines }} + {{ pages.maintainer.build_community.contributor_paths }} + {{ pages.maintainer.build_community.communication }}
diff --git a/templates/maintainer.html b/templates/maintainer.html index 834b77d..759411c 100644 --- a/templates/maintainer.html +++ b/templates/maintainer.html @@ -1,4 +1,47 @@ {% extends "_base.html" %} {% block body %} -

Community maintainer resources go here.

+
+
+

{{ pages.maintainer.title }}

+

{{ pages.maintainer.intro }}

+
+
+
+
+

{{ pages.maintainer.milestone.learn }}

+

{{ pages.maintainer.learn.intro }}

+
+ {{ 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.intro }}

+
+ {{ pages.maintainer.build_community.communication }} + {{ pages.maintainer.build_community.contributor_paths }} + {{ pages.maintainer.build_community.encourage }} +
+
+
+

{{ pages.maintainer.milestone.collection_inclusion }}

+

{{ pages.maintainer.collection_inclusion.intro }}

+
+ {{ pages.maintainer.collection_inclusion.process }} + {{ pages.maintainer.collection_inclusion.review }} +
+
+
+

{{ pages.maintainer.milestone.participate }}

+

{{ pages.maintainer.participate.intro }}

+
+ {{ pages.maintainer.participate.join }} +
+
+
+
+
{% endblock %}