Skip to content

Commit a0b2b6d

Browse files
author
Vivek Vishal
authored
Merge pull request #6406 from layer5io/update-handboo
add instructions GitHub Organization Membership
2 parents 956e066 + 2c476bc commit a0b2b6d

3 files changed

Lines changed: 151 additions & 0 deletions

File tree

‎src/pages/community/handbook/instructions.js‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import React from "react";
2+
3+
import SEO from "../../../components/seo";
4+
import GitHubOrgMembership from "../../../sections/Community/Handbook/instructions";
5+
6+
const GithubOrgMember = () => {
7+
return (
8+
<>
9+
<GitHubOrgMembership />
10+
11+
</>
12+
);
13+
};
14+
export default GithubOrgMember;
15+
export const Head = () => {
16+
return <SEO title="Instructions" description="Layer5 readily recognizes and publicly appreciates its community members." />;
17+
};

‎src/sections/Community/Handbook/index.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,12 @@ const handbookHome = () => {
113113
description="General frequently asked questions (FAQ) about Layer5 and people who contribute through reporting issues, to submit pull requests or patches, and other activities."
114114
to="/community/handbook/faq"
115115
/>
116+
117+
<HandbookCard
118+
title="GitHub Organization Membership"
119+
description="Recognition of consistent contributors through GitHub organization invitations, outlining membership requirements, invitation process, and responsibilities."
120+
to="/community/handbook/instructions"
121+
/>
116122
</div>
117123
</HandbookWrapper>
118124
);

‎src/sections/Community/Handbook/instructions.js‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
import React from "react";
2+
import { Container } from "../../../reusecore/Layout";
3+
import { HandbookWrapper } from "./Handbook.style";
4+
import TOC from "../../../components/handbook-navigation/index";
5+
import IntraPage from "../../../components/handbook-navigation/intra-page";
6+
import TocPagination from "../../../components/handbook-navigation/TocPagination";
7+
8+
const contents = [
9+
{ id: 0, link: "#top", text: "GitHub Organization Membership", },
10+
{ id: 1, link: "#Requirements", text: "Membership Requirements" },
11+
{ id: 2, link: "#InvitationProcess", text: "Invitation Process" },
12+
{ id: 3, link: "#TemplateMessage", text: "Template Message for Invitations", },
13+
{ id: 4, link: "#SendingInvitation", text: "Sending the GitHub Invitation", },
14+
];
15+
16+
const GitHubOrgMembership = () => {
17+
return (
18+
<HandbookWrapper>
19+
<div className="page-header-section">
20+
<h1>GitHub Organization Membership</h1>
21+
</div>
22+
<TOC />
23+
<div className="page-section">
24+
<Container>
25+
<div className="content">
26+
<a id="top">
27+
{" "}
28+
<h2>GitHub Organization Membership</h2>{" "}
29+
</a>
30+
31+
<p>
32+
Membership to the GitHub organizations is a significant milestone for contributors who have shown
33+
persistent commitment and dedication to Layer5 projects. It is not solely about writing code
34+
but rather the consistency of engagement and alignment of mentality.
35+
</p>
36+
37+
<a id="Requirements">
38+
{" "}
39+
<h4>
40+
<strong>Membership Requirements</strong>
41+
</h4>{" "}
42+
</a>
43+
44+
<p>
45+
Contributors who may be invited typically:
46+
<ul>
47+
<li>Have been actively involved in the community for several weeks</li>
48+
<li>Make regular updates to projects</li>
49+
<li>Help other community members</li>
50+
<li>Attend development meetings</li>
51+
<li>Demonstrate a willingness to learn and share knowledge</li>
52+
<li>Show a genuine desire to improve themselves, others, and the projects</li>
53+
</ul>
54+
</p>
55+
56+
<a id="InvitationProcess">
57+
{" "}
58+
<h4>
59+
<strong>Invitation Process</strong>
60+
</h4>{" "}
61+
</a>
62+
63+
<p>
64+
Depending on the number and quality of contributions made across the five GitHub organizations
65+
of Layer5, contributors can receive an invitation to any or all of these orgs. The process involves:
66+
<ol>
67+
<li>Sending a group DM</li>
68+
<li>Executing Slack slash command in #community-management</li>
69+
</ol>
70+
</p>
71+
72+
<a id="TemplateMessage">
73+
{" "}
74+
<h4>
75+
<strong>Template Message for Invitations</strong>
76+
</h4>{" "}
77+
</a>
78+
79+
<p>
80+
When you identify a worthy contributor, send the following message in a group DM that includes
81+
the individual and other maintainers/appropriate members:
82+
</p>
83+
<div className="message-template" style={{ marginBottom: "2rem" }}>
84+
<code>"Hi [name], a number of community members have noticed your recent efforts, which don't go unappreciated. You've been consistent with your engagement: both contributing yourself and providing helpful feedback to others here. As a token of recognition and to enable you to be even more impactful, we would also like to invite you to be a part of the Meshery GitHub organization. With your GitHub user as a member of the org, you may not only proudly display the Meshery badge on your user profile, but your user will also be empowered with issue triage/edit permissions org-wide. As you consider this, please know that accepting this invitation bears the responsibility of being a faithful steward of the community and representative of Layer5's values."</code>
85+
</div>
86+
87+
<a id="SendingInvitation">
88+
{" "}
89+
<h4>
90+
<strong>Sending the GitHub Invitation</strong>
91+
</h4>{" "}
92+
</a>
93+
94+
<p>
95+
To send the invitation to join the GitHub organization, use the following slash command in
96+
#community-management channel:
97+
</p>
98+
<div className="code-block">
99+
<code>/invite-github [email address] [organization name]</code>
100+
</div>
101+
<p>
102+
Where <strong>[organization name]</strong> should be either:
103+
<ul>
104+
<li>
105+
<strong>layer5io</strong> - to send the invite to the email address to join Layer5 GitHub org under the "layer5-contributors" team
106+
</li>
107+
<li>
108+
<strong>meshery</strong> - to send the invite to the email address to join Meshery GitHub organization under the "contributors" team
109+
</li>
110+
</ul>
111+
</p>
112+
<p>
113+
For example:
114+
</p>
115+
<div className="code-block">
116+
<code>/invite-github contributor@example.com layer5io</code>
117+
</div>
118+
</div>
119+
<TocPagination />
120+
</Container>
121+
122+
<IntraPage contents={contents} />
123+
</div>
124+
</HandbookWrapper>
125+
);
126+
};
127+
128+
export default GitHubOrgMembership;

0 commit comments

Comments
 (0)