You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/collections/handbook/community/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: "Community"
2
+
title: "Community Guidelines"
3
3
description: "A MeshMate is an experienced Layer5 community member, who will be available to guide you as you explore the various projects and find your areas of interest."
Copy file name to clipboardExpand all lines: src/collections/handbook/github-process/index.mdx
+154-5Lines changed: 154 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,38 +87,187 @@ Area labels specify which part of the project an issue or PR relates to—such a
87
87
### Component Labels
88
88
Component labels indicate which software module or subsystem is affected by an issue. This ensures issues are routed to the right maintainers and allows more detailed filtering beyond the broader area labels. Attach a component label when your issue/PR impacts a specific module (e.g., a CLI tool, API, or pattern engine).
Programming language labels highlight the primary language used in the issue or PR. This helps contributors looking for language-specific work, and aids in code review or help requests. Use a programming language label if the change, bug, or feature is specific to a particular language (e.g., a Go backend bug, a JavaScript UI enhancement).
PR labels manage the state or special requirements of a pull request, like indicating it's a draft, dependent on others, or not yet ready for merging. Apply a PR label if your pull request isn't ready, should not be merged, updates dependencies, or is on hold.
<tr><td>pr/do-not-merge</td><td>Not ready for merging</td><td>#0366d6</td></tr>
134
+
<tr><td>pr/draft</td><td>Work in progress/draft PR</td><td>#0366d7</td></tr>
135
+
<tr><td>pr/on hold</td><td>PR/Issue on hold</td><td>#0366d8</td></tr>
136
+
</tbody>
137
+
</table>
138
+
</div>
139
+
96
140
### Issue Process & Status Labels
97
141
These labels show the current status of an issue—such as blocked, duplicate, in need of a design, or if an action (like an invitation) should be triggered. Some are used by bots to automate reminders or mark stale issues. Apply these when the situation applies (e.g. "blocked" if work can't proceed, "design required" if more planning is needed).
<tr><td>issue/stale</td><td>No activity for an extended period (often applied automatically)</td><td>#eeeeee</td></tr>
155
+
<tr><td>issue/tweet</td><td>Posts (for social or outreach)</td><td>#eeeeee</td></tr>
156
+
<tr><td>issue/remind</td><td>Reminder comment to assignee</td><td>#eeeeee</td></tr>
157
+
<tr><td>issue/willfix</td><td>Issue will be worked on ("stale" bot skips)</td><td>#eeeeee</td></tr>
158
+
</tbody>
159
+
</table>
160
+
</div>
161
+
99
162
### Kind Labels
100
163
Kind labels classify the general type of change or discussion: bug, feature, chore, enhancement, epic, question, or proposal. This improves searchability and helps teams organize their workflows. Use the kind label that best describes your issue or PR.
<tr><td>kind/child</td><td>Child of a larger Epic</td><td>#088074</td></tr>
173
+
<tr><td>kind/chore</td><td>Maintenance or other necessary task</td><td>#088075</td></tr>
174
+
<tr><td>kind/enhancement</td><td>Improvement to an existing feature</td><td>#088076</td></tr>
175
+
<tr><td>kind/epic</td><td>An umbrella issue, covers many issues</td><td>#088077</td></tr>
176
+
<tr><td>kind/feature</td><td>New major feature or request</td><td>#088078</td></tr>
177
+
<tr><td>kind/proposal</td><td>Suggestion or proposal for change</td><td>#088079</td></tr>
178
+
<tr><td>kind/question</td><td>Explanation or further info requested</td><td>#088080</td></tr>
179
+
</tbody>
180
+
</table>
181
+
</div>
182
+
102
183
### Priority Labels
103
184
Priority labels help teams triage and allocate attention, making it clear which issues are urgent and which can wait. Always apply a priority label, adjusting as priorities shift or as issues are escalated or downgraded.
<tr><td>priority/low</td><td>Lower priority, can wait</td><td>#a60205</td></tr>
195
+
</tbody>
196
+
</table>
197
+
</div>
198
+
105
199
### Service Mesh Labels
106
200
Service mesh labels point out which mesh technology or ecosystem the issue pertains to. This is vital for projects supporting multiple meshes, enabling modular attention and expertise. Use these when your change or report is specific to one mesh (like Istio or Linkerd).
Help labels signal issues where some support is needed, or which are especially suitable for newcomers. These labels foster open source engagement and make onboarding easier for new contributors. Apply these to issues where you'd appreciate community help (`help wanted`) or for issues that are clearly documented, small in scope, and ideal for first-timers (`good first issue`).
<tr><td>help wanted</td><td>Maintainers need help here</td><td>#35f48e</td></tr>
232
+
<tr><td>good first issue</td><td>Good for new contributors</td><td>#7057ff</td></tr>
233
+
</tbody>
234
+
</table>
235
+
</div>
236
+
111
237
### Best Practices & Example
112
238
-**Apply all relevant labels**: an issue may belong to an area, a component, a kind, have a priority, AND be language-specific.
113
239
-**Update labels as issues evolve**: don't hesitate to add or remove as information changes.
114
-
-**When in doubt, ask!**: The <ahref="https://layer5.io/community">Layer5 community Slack</a> is a welcoming place.
240
+
-**When in doubt, ask!**: The [Layer5 community Slack](https://layer5.io/community) is a welcoming place.
241
+
242
+
**Example:**
243
+
244
+
If you find a documentation error regarding Meshery's CLI, that's an easy fix, you might use these labels:
115
245
116
-
**Example:**<br />
117
-
If you find a documentation error regarding Meshery's CLI, that's an easy fix, you might use these labels:<br/>
118
246
`area/docs, component/mesheryctl, kind/bug, priority/low, good first issue`
119
247
120
248
### Questions or Suggestions?
121
-
Labels missing? Unclear usage? Open a discussion or tag a maintainer in your issue, or bring it up in <ahref="https://layer5.io/community">community Slack</a>.
249
+
Labels missing? Unclear usage? Open a discussion or tag a maintainer in your issue, or bring it up in [community Slack](https://layer5.io/community).
250
+
251
+
### List for Pull Requests
252
+
The following list of pull request labels will be used to both indicate purpose or status of the PR to maintainers, and significantly, they will be used in conditional logic during workflow execution to determine the PR's appropriate path through the CI flow.
253
+
254
+
-**Refactor** - Chore related pull request
255
+
-**Fix** - Bug fixes PRs
256
+
-**On-hold** - PR needs review before merging or it needs to behold until a specific issue is fixed.
257
+
-**Dependabot** - All dependabot related automated PRs
258
+
-**release** - identifies that a release is / will be made
259
+
-**Draft** - PR is in draft state, GitHub provides a way for the draft state but having a label will help us in triage purposes.
260
+
-**Approved** - Indicates a PR has been approved by approver form all required OWNERS files. #51ed31
261
+
-**help wanted** - Extra attention is needed #008672
262
+
-**needs-ok-to-test** - #d60c6a
263
+
-**awaiting review** - The PR is ready for the reviewer to review. #fbca04
264
+
265
+
Improving the build times through conditional logic that will skip sections of the ci.yml, unless these labels are present:
266
+
267
+
-**docs** - build the Jekyll site for Meshery documentation
268
+
-**component/mesheryctl** - build the Meshery CLI
269
+
-**area/ui** - build the Meshery UI
270
+
-**component/meshery-server** - Assumed that Meshery Server should always be build, but this is not the case.
122
271
123
272
### Bots
124
273
Layer5 uses the following bots:
@@ -131,4 +280,4 @@ Layer5 uses the following bots:
131
280
- Labeler.yml
132
281
- label-commenter.yml
133
282
134
-
Good resource - <ahref="https://github.com/sdras/awesome-actions#pull-requests">https://github.com/sdras/awesome-actions#pull-requests</a>
283
+
Good resource - [https://github.com/sdras/awesome-actions#pull-requests](https://github.com/sdras/awesome-actions#pull-requests)
Copy file name to clipboardExpand all lines: src/collections/handbook/writing-program/index.mdx
+37-16Lines changed: 37 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -195,27 +195,48 @@ Do you want to document your recent effort in implementing a new feature? Do you
195
195
</div>
196
196
</div>
197
197
198
-
## Content Guidelines
199
198
200
-
-**Original**: All content must be original and not published elsewhere
201
-
-**Technical**: Focus on technical topics related to cloud native, Kubernetes, service mesh, and related technologies
202
-
-**Helpful**: Provide practical value to readers through tutorials, guides, or insights
203
-
-**Well-written**: Follow good writing practices with clear structure and proper grammar
204
-
-**Accurate**: Ensure all technical information is correct and up-to-date
205
199
206
-
## Recognition
200
+
## What are some suggested topics?
207
201
208
-
Published authors receive:
209
-
-**Byline**: Credit on published content
210
-
-**Profile**: Featured on the <Linkto="/community/members">community members</Link> page
211
-
-**Badge**: Writer badge on your community profile
212
-
-**Promotion**: Social media promotion of your content
213
-
-**Swag**: Layer5 swag for significant contributions
202
+
Here are some suggested topics to get you started. If you have an idea that isn't listed here or if you have any question, please let us know on our [Discuss Forum](https://discuss.layer5.io/) / [Slack Channel](https://layer5io.slack.com/).
203
+
204
+
-**DevOps/Observability/Kubernetes:**
205
+
- Distributed Tracing in Context of Meshery's Architecture.
206
+
- One-stop Cloud Native Market Place - Meshery Catalog.
207
+
- Interpreting your Cloud Native Performance - SMP.
208
+
- Creating and Deploying your first application with Kanvas.
209
+
- Load generation and Load balancing.
210
+
- DevOps and Platform Engineering.
211
+
- Beginners guide to Meshmodel.
212
+
- Enhancing Microservices Observability with Meshery and Prometheus.
213
+
214
+
-**Community:**
215
+
- Building Bridges, Not Walls: The Power of Open Source Collaboration.
216
+
- A Deep Dive into Meshery's Contribution to Cloud Native Ecosystem.
217
+
- Open Source Sustainability: Funding Models for Long-Term GitHub Projects.
218
+
- Importance to an open source community.
219
+
- Beyond Code: The Unsung Heroes of Open Source - Documenters, Testers, and Designers.
220
+
- Open Source Alchemy: Transforming Community Contributions into Gold.
221
+
- Collaborative Open Source Development: Inside the Community of Layer5.
222
+
223
+
## How to Submit and Review Your Writing?
224
+
225
+
The Writing Program offers writers two convenient ways to get their writings reviewed by Community. Whether you prefer working with Google Docs or contributing directly to the website, we've got you covered. This structured guide will walk you through both options, ensuring that your valuable content is reviewed effectively.
226
+
227
+
1.**Google Docs Review:**
228
+
229
+
If you prefer a straightforward approach, start by crafting your blog article within [Google Docs](https://docs.google.com/), ensuring it's well-structured and error-free. Share the document with us by adding it to the [Community Drive](https://drive.google.com/drive/folders/1o6ZSqCq1QUJmLIjl_Y0VgT_azNbgg1W2), we will provide feedback directly within the Google Doc. Engage in discussions to refine your content collaboratively. Once thoroughly reviewed, prepare your submission according to community guidelines.
230
+
231
+
2.**Website Contribution Review:**
232
+
233
+
For those comfortable with local website development, contribute directly to the community website. [Set up your local environment](https://github.com/layer5io/layer5/blob/master/CONTRIBUTING.md), create a blog post adhering to specified guidelines, and submit it via a Pull Request on [GitHub](https://github.com/layer5io/layer5/). Reviewers will provide feedback, and you'll refine your post collaboratively. Upon completion, maintainers will merge your blog post into the website repository, celebrating your contribution.
214
234
215
235
## Additional Resources
216
236
217
-
- <ahref="https://github.com/layer5io/layer5/blob/master/CONTRIBUTING.md#adding-a-resource">Contributing to Layer5 Resources</a>
218
-
- Join the <ahref="https://discuss.layer5.io/">Layer5 Discussion Forum</a>
237
+
-[Contributing to Layer5 Blogs](https://github.com/layer5io/layer5/blob/master/CONTRIBUTING.md#adding-a-blog-post)
238
+
-[Contributing to Layer5 Resources](https://github.com/layer5io/layer5/blob/master/CONTRIBUTING.md#adding-a-resource)
239
+
-[View open Writing Program issues](https://github.com/layer5io/layer5/labels/area%2Fblog)
240
+
- Join the [Layer5 Discussion Forum](https://discuss.layer5.io/)
0 commit comments