Skip to content

Commit 0c7ad82

Browse files
added missing content and fix toc active
Signed-off-by: Rajesh-Nagarajan-11 <rajeshnagarajan36@gmail.com>
1 parent 9233241 commit 0c7ad82

4 files changed

Lines changed: 193 additions & 24 deletions

File tree

src/collections/handbook/community/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Community"
2+
title: "Community Guidelines"
33
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."
44
type: Handbook
55
contents:

src/collections/handbook/github-process/index.mdx

Lines changed: 154 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,38 +87,187 @@ Area labels specify which part of the project an issue or PR relates to—such a
8787
### Component Labels
8888
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).
8989

90+
<div className="table-container">
91+
<table>
92+
<thead>
93+
<tr><th>Label</th><th>Description</th><th>Color</th></tr>
94+
</thead>
95+
<tbody>
96+
<tr><td>component/api</td><td>API related</td><td>#3a0485</td></tr>
97+
<tr><td>component/mesheryctl</td><td>Meshery CLI related</td><td>#3a0486</td></tr>
98+
<tr><td>component/ui</td><td>UI component related</td><td>#3a0486</td></tr>
99+
<tr><td>component/filters</td><td>Filters related</td><td>#3a0486</td></tr>
100+
<tr><td>component/patterns</td><td>Patterns related</td><td>#3a0486</td></tr>
101+
<tr><td>component/meshsync</td><td>MeshSync component related</td><td>#3a0487</td></tr>
102+
<tr><td>component/meshery-perf</td><td>Meshery-perf related</td><td>#3a0488</td></tr>
103+
</tbody>
104+
</table>
105+
</div>
106+
90107
### Programming Language Labels
91108
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).
92109

110+
<div className="table-container">
111+
<table>
112+
<thead>
113+
<tr><th>Label</th><th>Description</th><th>Color</th></tr>
114+
</thead>
115+
<tbody>
116+
<tr><td>language/go</td><td>Golang related</td><td>#16e2e2</td></tr>
117+
<tr><td>language/javascript</td><td>Javascript</td><td>#16e2e3</td></tr>
118+
<tr><td>language/ruby</td><td>Ruby</td><td>#16e2e4</td></tr>
119+
</tbody>
120+
</table>
121+
</div>
122+
93123
### PR (Pull Request) Labels
94124
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.
95125

126+
<div className="table-container">
127+
<table>
128+
<thead>
129+
<tr><th>Label</th><th>Description</th><th>Color</th></tr>
130+
</thead>
131+
<tbody>
132+
<tr><td>pr/dependencies</td><td>Updates addressed dependencies</td><td>#0366d5</td></tr>
133+
<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+
96140
### Issue Process & Status Labels
97141
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).
98142

143+
<div className="table-container">
144+
<table>
145+
<thead>
146+
<tr><th>Label</th><th>Description</th><th>Color</th></tr>
147+
</thead>
148+
<tbody>
149+
<tr><td>issue/invite</td><td>Invitation for author to join GH org</td><td>#eeeeee</td></tr>
150+
<tr><td>issue/blocked</td><td>Issue is blocked</td><td>#eeeeee</td></tr>
151+
<tr><td>issue/design required</td><td>Requires a design prior to proceeding</td><td>#eeeeee</td></tr>
152+
<tr><td>issue/duplicate</td><td>Issue or PR already exists</td><td>#eeeeee</td></tr>
153+
<tr><td>issue/invalid</td><td>This doesn't seem right</td><td>#eeeeee</td></tr>
154+
<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+
99162
### Kind Labels
100163
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.
101164

165+
<div className="table-container">
166+
<table>
167+
<thead>
168+
<tr><th>Label</th><th>Description</th><th>Color</th></tr>
169+
</thead>
170+
<tbody>
171+
<tr><td>kind/bug</td><td>Something isn't working</td><td>#088073</td></tr>
172+
<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+
102183
### Priority Labels
103184
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.
104185

186+
<div className="table-container">
187+
<table>
188+
<thead>
189+
<tr><th>Label</th><th>Description</th><th>Color</th></tr>
190+
</thead>
191+
<tbody>
192+
<tr><td>priority/urgent</td><td>Needs immediate attention</td><td>#f60205</td></tr>
193+
<tr><td>priority/high</td><td>High priority issue</td><td>#d60205</td></tr>
194+
<tr><td>priority/low</td><td>Lower priority, can wait</td><td>#a60205</td></tr>
195+
</tbody>
196+
</table>
197+
</div>
198+
105199
### Service Mesh Labels
106200
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).
107201

202+
<div className="table-container">
203+
<table>
204+
<thead>
205+
<tr><th>Label</th><th>Description</th><th>Color</th></tr>
206+
</thead>
207+
<tbody>
208+
<tr><td>service-mesh/app-mesh</td><td>App Mesh</td><td>#57b6cc</td></tr>
209+
<tr><td>service-mesh/consul</td><td>Consul</td><td>#57b6cc</td></tr>
210+
<tr><td>service-mesh/cpx</td><td>CPX</td><td>#57b6cc</td></tr>
211+
<tr><td>service-mesh/istio</td><td>Istio</td><td>#57b6cc</td></tr>
212+
<tr><td>service-mesh/kuma</td><td>Kuma</td><td>#57b6cc</td></tr>
213+
<tr><td>service-mesh/linkerd</td><td>Linkerd</td><td>#57b6cc</td></tr>
214+
<tr><td>service-mesh/maesh</td><td>Maesh</td><td>#57b6cc</td></tr>
215+
<tr><td>service-mesh/nginx</td><td>NGINX SM</td><td>#57b6cc</td></tr>
216+
<tr><td>service-mesh/nsm</td><td>NSM</td><td>#57b6cc</td></tr>
217+
<tr><td>service-mesh/tanzu</td><td>Tanzu</td><td>#57b6cc</td></tr>
218+
</tbody>
219+
</table>
220+
</div>
221+
108222
### Help & Onboarding Labels
109223
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`).
110224

225+
<div className="table-container">
226+
<table>
227+
<thead>
228+
<tr><th>Label</th><th>Description</th><th>Color</th></tr>
229+
</thead>
230+
<tbody>
231+
<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+
111237
### Best Practices & Example
112238
- **Apply all relevant labels**: an issue may belong to an area, a component, a kind, have a priority, AND be language-specific.
113239
- **Update labels as issues evolve**: don't hesitate to add or remove as information changes.
114-
- **When in doubt, ask!**: The <a href="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:
115245

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/>
118246
`area/docs, component/mesheryctl, kind/bug, priority/low, good first issue`
119247

120248
### Questions or Suggestions?
121-
Labels missing? Unclear usage? Open a discussion or tag a maintainer in your issue, or bring it up in <a href="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.
122271

123272
### Bots
124273
Layer5 uses the following bots:
@@ -131,4 +280,4 @@ Layer5 uses the following bots:
131280
- Labeler.yml
132281
- label-commenter.yml
133282

134-
Good resource - <a href="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)

src/collections/handbook/writing-program/index.mdx

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -195,27 +195,48 @@ Do you want to document your recent effort in implementing a new feature? Do you
195195
</div>
196196
</div>
197197

198-
## Content Guidelines
199198

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
205199

206-
## Recognition
200+
## What are some suggested topics?
207201

208-
Published authors receive:
209-
- **Byline**: Credit on published content
210-
- **Profile**: Featured on the <Link to="/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.
214234

215235
## Additional Resources
216236

217-
- <a href="https://github.com/layer5io/layer5/blob/master/CONTRIBUTING.md#adding-a-resource">Contributing to Layer5 Resources</a>
218-
- Join the <a href="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/)
219241
- Explore our <Link to="/resources">Resource Library</Link>
220242
- <Link to="/learn">Learn Cloud Native</Link>
221-
- Connect with us on <a href="https://slack.layer5.io/">Slack</a>

src/sections/Community/Handbook/handbook-single/HandbookTOC.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ const HandbookTOC = ({ pages, currentSlug }) => {
1818
<li key={index}>
1919
<Link
2020
to={page.fields.slug}
21-
className="toc-sub-heading toc-sub-inline"
22-
activeClassName="active"
21+
className={`toc-sub-heading toc-sub-inline${page.fields.slug === currentSlug ? " active" : ""}`}
2322
>
2423
{page.frontmatter.title}
2524
</Link>

0 commit comments

Comments
 (0)