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

Updated template for maintainers.html #128

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions build.py
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
20 changes: 0 additions & 20 deletions data/links.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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:
Expand Down
61 changes: 61 additions & 0 deletions data/maintainers.yaml
Original file line number Diff line number Diff line change
@@ -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"
32 changes: 2 additions & 30 deletions data/pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ <h4> {{ pages.index.maintainer_heading }} <i class="fas fa-project-diagram"></i>
</h4>
<!--<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" href="{{ links.maintainer.learn.guidelines }}" role="button">{{ pages.maintainer.learn.guidelines }}</a>
<a class="btn" href="{{ links.maintainer.build_community.contributor_paths }}" role="button">{{ pages.maintainer.build_community.contributor_paths }}</a>
<a class="btn" href="{{ links.maintainer.build_community.grow_community }}" role="button">{{ pages.maintainer.build_community.grow_community }}</a>
<a class="btn" href="{{ maintainers.milestones.learn.actions.guidelines.link }}" role="button">{{ maintainers.milestones.learn.actions.guidelines.label }}</a>
<a class="btn" href="{{ maintainers.milestones.build_community.actions.contributor_paths.link }}" role="button">{{ maintainers.milestones.build_community.actions.contributor_paths.label }}</a>
<a class="btn" href="{{ maintainers.milestones.build_community.actions.grow_community.link }}" role="button">{{ maintainers.milestones.build_community.actions.grow_community.label }}</a>
<a class="btn" href="{{ links.site.maintainer }}" role="button"><i class="fas fa-angle-double-right"></i>&nbsp;{{ pages.index.maintainer_resources_action }}</a>
</div>
</div>
Expand Down
66 changes: 16 additions & 50 deletions templates/maintainers.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
{% extends "_base.html" %}
{% block body %}
{% extends "_base.html" %} {% block body %}
<div class="container">
<div class="full-width-bg component">
<div class="grid-wrapper">
<!--<div class="width-3-12 width-12-12-m">
<img class="page-logo" src="static/images/community_logo.svg">
</div>-->
<div class="full-width-bg component">
<div class="grid-wrapper">
<div class="width-9-12 width-12-12-m">
<div class="page-title">
<h2>{{ pages.maintainer.title }}</h2>
<p>{{ pages.maintainer.intro }}</p>
<h2>{{ pages.maintainers.title }}</h2>
<p>{{ pages.maintainers.intro }}</p>
<p class="feedback">{{ pages.feedback }}</p>
</div>
</div>
Expand All @@ -18,59 +14,29 @@ <h2>{{ pages.maintainer.title }}</h2>
<div class="quicklinks">
<h2>{{ pages.quicklinks.heading }}</h2>
<ul class="fa-ul">
{%- for key, item in maintainers.quicklinks.items() %}
<li>
<span class="fa-li"><i class="fas fa-book"></i></span>
<a href="{{ links.quicklinks.maintainer_news }}" target="_blank">{{ pages.quicklinks.maintainer_news }}</a>
</li>
<li>
<span class="fa-li"><i class="fas fa-book"></i></span>
<a href="{{ links.quicklinks.community_topics }}" target="_blank">{{ pages.quicklinks.community_topics }}</a>
</li>
<li>
<span class="fa-li"><i class="fas fa-book"></i></span>
<a href="{{ links.maintainer.collection_inclusion.process }}" target="_blank">{{ pages.quicklinks.package_inclusion }}</a>
<a href="{{ item.link }}" target="_blank">{{ item.label }}</a>
</li>
{%- endfor %}
</ul>
<hr />
</div>
</div>
<!-- End quicklinks. -->
<!-- Start community maintainer journey. -->
{% for key, value in maintainers.milestones.items() -%}
<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" href="{{ links.maintainer.learn.guidelines }}" role="button">{{ pages.maintainer.learn.guidelines }}</a>
<a class="btn" href="{{ links.maintainer.learn.backports }}" role="button">{{ pages.maintainer.learn.backports }}</a>
<a class="btn" href="{{ links.maintainer.learn.release }}" role="button">{{ pages.maintainer.learn.release }}</a>
<a class="btn" 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" href="{{ links.maintainer.build_community.grow_community }}" role="button">{{ pages.maintainer.build_community.grow_community }}</a>
<a class="btn" href="{{ links.maintainer.build_community.documentation }}" role="button">{{ pages.maintainer.build_community.documentation }}</a>
<a class="btn" href="{{ links.maintainer.build_community.contributor_paths }}" role="button">{{ pages.maintainer.build_community.contributor_paths }}</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" href="{{ links.maintainer.collection_inclusion.process }}" role="button">{{ pages.maintainer.collection_inclusion.process }}</a>
<a class="btn" href="{{ links.maintainer.collection_inclusion.review }}" role="button">{{ pages.maintainer.collection_inclusion.review }}</a>
<a class="btn" href="{{ links.maintainer.collection_inclusion.submit }}" role="button">{{ pages.maintainer.collection_inclusion.submit }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.maintainer.milestone.participate }}</h3>
<!--<p>{{ pages.maintainer.participate.intro }}</p>-->
<h3>{{ value.heading }}</h3>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn" href="{{ links.maintainer.participate.join }}" role="button">{{ pages.maintainer.participate.community_topics }}</a>
<a class="btn" href="{{ links.maintainer.participate.join }}" role="button">{{ pages.maintainer.participate.join }}</a>
{%- for action_key, action_value in value.actions.items() %}
<a class="btn" href="{{ action_value.link }}" role="button">{{ action_value.label }}</a>
{%- endfor %}
</div>
</div>
{% endfor -%}
<!-- End community maintainer journey. -->
</div>
</div>
</div>
Expand Down