Skip to content
This repository has been archived by the owner on Oct 10, 2023. It is now read-only.

Commit

Permalink
add maintainer journeys (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
oraNod authored Mar 10, 2023
1 parent 7b47057 commit 3968c49
Show file tree
Hide file tree
Showing 4 changed files with 93 additions and 12 deletions.
19 changes: 15 additions & 4 deletions data/links.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
35 changes: 31 additions & 4 deletions data/pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
6 changes: 3 additions & 3 deletions templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ <h5>{{ pages.index.developer_resources_heading }}</h5>
<h5>{{ pages.index.maintainer_heading }} <i class="fas fa-project-diagram"></i></h5>
<p class="card-text">{{ pages.index.maintainer_body }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.maintainer_actions.overview }}" role="button">{{ pages.index.maintainer_actions.overview}}</a>
<a class="btn btn-primary" href="{{ links.maintainer_actions.learn }}" role="button">{{ pages.index.maintainer_actions.learn }}</a>
<a class="btn btn-primary" href="{{ links.maintainer_actions.join }}" role="button">{{ pages.index.maintainer_actions.join }}</a>
<a class="btn btn-primary" href="{{ links.maintainer.learn.guidelines }}" role="button">{{ pages.maintainer.learn.guidelines }}</a>
<a class="btn btn-primary" href="{{ links.maintainer.build_community.contributor_paths }}" role="button">{{ pages.maintainer.build_community.contributor_paths }}</a>
<a class="btn btn-primary" href="{{ links.maintainer.build_community.communication }}" role="button">{{ pages.maintainer.build_community.communication }}</a>
</div>
</div>
</div>
Expand Down
45 changes: 44 additions & 1 deletion templates/maintainer.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,47 @@
{% extends "_base.html" %}
{% block body %}
<p>Community maintainer resources go here.</p>
<div class="container">
<div class="page-title">
<h2>{{ pages.maintainer.title }}</h2>
<p>{{ pages.maintainer.intro }}</p>
</div>
<div class="full-width-bg component">
<div class="grid-wrapper">
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.maintainer.milestone.learn }}</h3>
<p>{{ pages.maintainer.learn.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.maintainer.learn.guidelines }}" role="button">{{ pages.maintainer.learn.guidelines }}</a>
<a class="btn btn-primary" href="{{ links.maintainer.learn.backports }}" role="button">{{ pages.maintainer.learn.backports }}</a>
<a class="btn btn-primary" href="{{ links.maintainer.learn.release }}" role="button">{{ pages.maintainer.learn.release }}</a>
<a class="btn btn-primary" href="{{ links.maintainer.learn.documentation }}" role="button">{{ pages.maintainer.learn.documentation }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.maintainer.milestone.build_community }}</h3>
<p>{{ pages.maintainer.build_community.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.maintainer.build_community.communication }}" role="button">{{ pages.maintainer.build_community.communication }}</a>
<a class="btn btn-primary" href="{{ links.maintainer.build_community.contributor_paths }}" role="button">{{ pages.maintainer.build_community.contributor_paths }}</a>
<a class="btn btn-primary" href="{{ links.maintainer.build_community.encourage }}" role="button">{{ pages.maintainer.build_community.encourage }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.maintainer.milestone.collection_inclusion }}</h3>
<p>{{ pages.maintainer.collection_inclusion.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.maintainer.collection_inclusion.process }}" role="button">{{ pages.maintainer.collection_inclusion.process }}</a>
<a class="btn btn-primary" href="{{ links.maintainer.collection_inclusion.review }}" role="button">{{ pages.maintainer.collection_inclusion.review }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.maintainer.milestone.participate }}</h3>
<p>{{ pages.maintainer.participate.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.maintainer.participate.join }}" role="button">{{ pages.maintainer.participate.join }}</a>
</div>
</div>
</div>
</div>
</div>
{% endblock %}

0 comments on commit 3968c49

Please sign in to comment.