Skip to content

Commit 26bbc28

Browse files
authored
Merge branch 'master' into fix/seo-alt-links-kanvas
Signed-off-by: Azizah2023 <[email protected]>
2 parents 8535ff9 + 6c8cc1f commit 26bbc28

File tree

534 files changed

+20927
-6900
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

534 files changed

+20927
-6900
lines changed
1.93 KB
Loading
Lines changed: 18 additions & 0 deletions
Loading
1.95 KB
Loading
Lines changed: 18 additions & 0 deletions
Loading

.github/workflows/slack.yml

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,27 @@ jobs:
1515
- name: Get current star count
1616
run: |
1717
echo "STARS=$(curl --silent 'https://api.github.com/repos/${{ github.repository }}' -H 'Accept: application/vnd.github.preview' | jq '.stargazers_count')" >> $GITHUB_ENV
18+
1819
- name: Notify Slack
19-
env:
20-
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
21-
uses: pullreminders/slack-action@master
20+
uses: slackapi/[email protected]
2221
with:
23-
args: '{\"channel\":\"CSK7N9TGX\",\"text\":\"${{ github.actor }} just starred ${{ github.repository }}! (https://github.com/${{ github.repository }}/stargazers) Total ⭐️: ${{ env.STARS }}\"}'
22+
method: chat.postMessage
23+
token: ${{ secrets.SLACK_BOT_TOKEN }}
24+
payload: |
25+
channel: CSK7N9TGX
26+
type: "mrkdwn"
27+
text: "<https://github.com/${{ github.actor }}|${{ github.actor }}> just starred <https://github.com/${{ github.repository }}/stargazers|${{ github.repository }}> bringing the total ⭐️ count up to: ${{ env.STARS }}"
2428
2529
good-first-issue-notify:
2630
if: github.event_name == 'issues' && (github.event.label.name == 'good first issue' || github.event.label.name == 'first-timers-only')
2731
name: Notify Slack for new good-first-issue
2832
runs-on: ubuntu-latest
2933
steps:
3034
- name: Notify Slack
31-
env:
32-
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
33-
uses: pullreminders/slack-action@master
35+
uses: slackapi/[email protected]
3436
with:
35-
args: '{\"channel\":\"C019426UBNY\",\"type\":\"section\",\"text\":\":new: Good first issue up for grabs: ${{ github.event.issue.title }} - ${{ github.event.issue.html_url }} \"}'
36-
37+
method: chat.postMessage
38+
token: ${{ secrets.SLACK_BOT_TOKEN }}
39+
payload: |
40+
channel: C019426UBNY
41+
text: ":new: Good first issue up for grabs: <${{ github.event.issue.html_url }}|${{ github.event.issue.title }}>"

AGENTS.md

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# AGENTS.md
2+
3+
This document provides instructions for Large Language Models (LLMs) contributing to the Layer5 website, hosted at https://github.com/layer5io/layer5, built with Gatsby.js. These guidelines ensure consistency, quality, and alignment with the project's goals of promoting cloud native infrastructure management through clear documentation and user-friendly content.
4+
5+
## Project Overview
6+
7+
The Layer5 website (https://layer5.io) is a Gatsby.js-based static site that serves as the primary interface for the Layer5 community. It showcases projects like Meshery, Kanvas, and Cloud Native Patterns, and provides resources for contributors, users, and cloud native enthusiasts. The site emphasizes clean design, fast performance, and accessibility.
8+
9+
## Instructions for LLMs
10+
11+
### 1. Content Generation Guidelines
12+
13+
- **Tone and Style**: Use a professional yet approachable tone. Content should be clear, concise, and welcoming to both technical and non-technical audiences. Align with Layer5's mission of empowering engineers to "expect more from their infrastructure."
14+
- **Markdown Usage**: All content must be written in Markdown, adhering to Gatsby's content structure (e.g., MDX files in `src/pages` or `src/content`).
15+
- **Frontmatter**: Include appropriate frontmatter in MDX files. Example:
16+
17+
```yaml
18+
---
19+
title: "Page Title"
20+
path: "/path/to/page"
21+
date: "2025-09-23"
22+
description: "Short description for SEO."
23+
---
24+
```
25+
- **SEO Optimization**: Ensure all generated content includes meta descriptions, relevant keywords (e.g., "cloud native," "Meshery," "service mesh"), and proper heading structures (H1, H2, etc.).
26+
- **Consistency**: Use American English spelling and grammar. Follow the Layer5 Writing Style Guide for terminology (e.g., "Meshery" not "meshery").
27+
28+
### 2. Code Contributions
29+
30+
- **Gatsby.js Structure**: Familiarize yourself with the repository structure:
31+
- `src/components`: Reusable React components.
32+
- `src/pages`: Page templates and MDX content.
33+
- `gatsby-config.js`: Site metadata and plugins.
34+
- `gatsby-node.js`: Dynamic page generation logic.
35+
- **React Components**: When generating components, use functional components with modern JavaScript (ES6+). Example:
36+
37+
```jsx
38+
import React from 'react';
39+
40+
const MyComponent = ({ title }) => (
41+
<div className="my-component">
42+
<h2>{title}</h2>
43+
</div>
44+
);
45+
46+
export default MyComponent;
47+
```
48+
- **Styling**: Use CSS modules or styled-components as per the project's conventions. Prefer Tailwind CSS classes if integrated. Example:
49+
50+
```jsx
51+
<div className="bg-blue-500 text-white p-4">Content</div>
52+
```
53+
- **Accessibility**: Ensure all components meet WCAG 2.1 standards (e.g., alt text for images, ARIA labels where needed).
54+
55+
### 3. Contribution Workflow
56+
57+
- **Pull Requests**: All changes must be submitted as pull requests (PRs) to the `master` branch. Follow the Layer5 Contributing Guidelines.
58+
- **Commit Messages**: Use clear, descriptive commit messages following the Conventional Commits format:
59+
60+
```
61+
feat: add new Meshery feature page
62+
fix: correct broken link in footer
63+
docs: update AGENTS.md with LLM instructions
64+
```
65+
- **Testing**: Ensure generated code passes `make setup` and `make site` without errors. Test for responsiveness across devices.
66+
- Verifying your fix: The website takes a long time to build. Don't interrupt the build when checking terminal output. Don't hail victory on a fix before you have ACTUALLY verified the solution. Wait for the website to be running, for you to actually \`curl\` a page and verify rendered content.
67+
68+
### 4. Content Restrictions
69+
70+
- **No External Images**: Do not include external image URLs in Markdown or components. Use local assets in `src/images`.
71+
- **No Placeholder Text**: Avoid placeholders like `[Your Name]` or `[Insert Content]`. Provide complete, usable content.
72+
- **No Sensitive Data**: Do not include API keys, credentials, or personal information in generated content.
73+
74+
### 5. Specific Tasks for LLMs
75+
76+
- **Documentation Updates**: Generate or update MDX files in `src/content` for tutorials, blog posts, or project documentation. Ensure alignment with Layer5's Documentation Guidelines.
77+
- **Blog Posts**: Create blog posts about cloud native topics, Meshery features, or community events. Example structure:
78+
79+
```markdown
80+
---
81+
title: "Exploring Meshery's New Features in 2025"
82+
path: "/blog/meshery-new-features-2025"
83+
date: "2025-09-23"
84+
description: "Discover the latest updates to Meshery, the cloud native management platform."
85+
---
86+
# Exploring Meshery's New Features in 2025
87+
## Introduction
88+
Meshery continues to evolve as the leading platform for...
89+
```
90+
- **Component Generation**: Create reusable React components for UI elements like buttons, cards, or modals, ensuring they match the site's design system.
91+
92+
### 6. Validation and Testing
93+
94+
- **Linting**: Run `npm run lint` to ensure code adheres to ESLint and Prettier rules.
95+
- **Build Testing**: Verify that `gatsby build` completes successfully.
96+
- **Preview**: Test changes locally with `gatsby develop` and check for visual/functional issues.
97+
98+
### 7. Community Alignment
99+
100+
- **CNCF Code of Conduct**: All contributions must adhere to the CNCF Code of Conduct.
101+
- **Engage with MeshMates**: For guidance, reference the MeshMates program in the Layer5 Community Handbook.
102+
103+
## Example Contribution
104+
105+
Below is an example of a new MDX page for the Layer5 website:
106+
107+
```markdown
108+
---
109+
title: "Getting Started with Meshery"
110+
path: "/learn/getting-started"
111+
date: "2025-09-23"
112+
description: "A beginner's guide to setting up Meshery for cloud native management."
113+
---
114+
# Getting Started with Meshery
115+
Meshery is an open-source cloud native management platform that simplifies...
116+
117+
## Installation
118+
1. Install Meshery CLI using:
119+
```bash
120+
curl -L https://meshery.io/install | bash -
121+
```
122+
123+
2. Verify installation:
124+
125+
```bash
126+
mesheryctl system check
127+
```
128+
129+
## Next Steps
130+
131+
Explore Meshery Docs for advanced configurations.
132+
133+
```
134+
135+
## Troubleshooting
136+
- **Build Errors**: Check `gatsby-config.js` for plugin misconfigurations.
137+
- **Content Issues**: Validate MDX syntax using `npm run develop`.
138+
- **Community Support**: Reach out via the [Layer5 Slack](https://slack.layer5.io) for assistance.
139+
140+
By following these guidelines, LLMs can contribute high-quality content and code to the Layer5 website, enhancing its role as a hub for the cloud native community.
141+
```

README.md

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<img src="https://img.shields.io/github/contributors/layer5io/layer5.svg" /></a>
1212
<a href="https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+(org%3Alayer5io+OR+org%3Ameshery+OR+org%3Alayer5labs+OR+org%3Aservice-mesh-performance+OR+org%3Aservice-mesh-patterns+OR+org%3Ameshery-extensions)+label%3A%22help+wanted%22" alt="Help wanted GitHub issues">
1313
<img src="https://img.shields.io/github/issues/layer5io/layer5/help%20wanted.svg?color=%23DDDD00" /></a>
14-
<a href="https://slack.layer5.io" alt="Slack">
14+
<a href="https://slack.layer5.io" alt="S/lack">
1515
<img src="https://img.shields.io/badge/[email protected]?logo=slack" /></a>
1616
<a href="https://twitter.com/layer5" alt="Twitter Follow">
1717
<img src="https://img.shields.io/twitter/follow/layer5.svg?label=Follow+Layer5&style=social" /></a>
@@ -23,7 +23,7 @@
2323

2424
# About Layer5
2525

26-
[Layer5](https://layer5.io)'s cloud native application and infrastructure management software enables engineers to expect more from their infrastructure. We embrace _developer_-defined infrastructure. We empower developers to change how they write applications, support _operators_ in rethinking how they run modern infrastructure, and enable _product owners_ to regain full-control over their product portfolio.
26+
[Layer5](https://layer5.io)'s cloud native application and infrastructure management software enables engineers to expect more from their infrastructure. We embrace _developer_-defined infrastructure. We empower developers to change how they write applications, support _operators_ in rethinking how they run modern infrastructure, and enable _product owners_ to regain full-control over their product portfolio. [Docs](https://docs.layer5.io)
2727

2828
# Projects
2929

@@ -32,7 +32,7 @@
3232
<a href="https://meshery.io">
3333
<img src=".github/assets/images/meshery/meshery-logo.svg" style="margin:10px;" width="125px" alt="Meshery - Cloud Native Management Plane" align="left" />
3434
</a>
35-
<a href="https://meshery.io">Meshery</a> is the collaborative cloud native manager that enables the adoption, operation, and management of Kubernetes and its workloads.
35+
<a href="https://meshery.io">Meshery</a> is the collaborative cloud native manager that enables the adoption, operation, and management of Kubernetes and its workloads. [Docs](https://docs.meshery.io)
3636
<br /><br /><br/>
3737
</p>
3838
<br />
@@ -43,17 +43,54 @@
4343
<a href="https://layer5.io/kanvas">
4444
<img src="src/assets/images/kanvas/icon-only/kanvas-icon-color.svg" alt="Kanvas logo" width="125px" style="margin:10px;" align="left" />
4545
</a>
46-
<a href="https://layer5.io/kanvas">Kanvas</a> is an end-to-end management platform, here to help teams understand problems, deploy designs, apply patterns, manage and operate your deployments and services in real-time.
46+
<a href="https://layer5.io/kanvas">Kanvas</a> is an end-to-end management platform, here to help teams understand problems, deploy designs, apply patterns, manage and operate your deployments and services in real-time. [Docs](https://docs.kanvas.new)
4747
<br /><br /><br/>
4848
</p>
4949
<br />
5050

51+
<p style="clear:both;">
52+
<h2><a href="https://layer5.io/projects/nighthawk">Nighthawk</a></h2>
53+
<a href="https://getnighthawk.dev/">
54+
<img src=".github/assets/images/getnighthawk/layer5-getnighthawk.webp"
55+
style="float:left;margin:10px;" width="125px"
56+
alt="Nighthawk" align="left" />
57+
</a>
58+
<a href="https://getnighthawk.dev/">Nighthawk</a> is a Layer 7 (HTTP/HTTPS/HTTP2) performance characterization tool. Nighthawk is Envoy’s load generator and is written in C++. Meshery integrates Nighthawk as one of (currently) three choices of load generator for characterizing and managing the performance of infrastructure and services.
59+
<br /><br /><br />
60+
</p>
61+
62+
<p style="clear:both;">
63+
<h2><a href="https://cloud.layer5.io/catalog">Cloud Native Catalog</a></h2>
64+
<a href="">
65+
<img src=".github/assets/images/catalog/catalog.svg"
66+
style="float:left;margin:10px;" width="125px"
67+
alt="Meshery Catalog" align="left" />
68+
</a>
69+
<a href="">Layer5 Catalog</a> As a central hub for sharing cloud native infrastructure designs, Meshery Catalog enables the exchange of the best practices, reusable templates, and Kubernetes-based operational patterns for multi-cluster Kubernetes clusters and distributed applications. Meshery Catalog serves as a marketplace full of curated cloud native infrastructure configurations and operational patterns perfect for DevOps engineers who seek to leverage and contribute to Meshery's large collection of design patterns.
70+
<br /><br /><br />
71+
</p>
72+
73+
<!-- Layer 5 academy -->
74+
<p style="clear:both;">
75+
<h2><a href="https://cloud.layer5.io/academy">Layer5 Academy</a></h2>
76+
<a href="https://cloud.layer5.io/academy">
77+
<img src=".github/assets/images/academy/academy-layer5-light.svg" style="margin:10px;" width="125px" alt="Layer5 Academy" align="left" />
78+
</a>
79+
<a href="https://cloud.layer5.io/academy">Layer5 Academy</a> Layer5 Academy is a learning platform built into Layer5 Cloud. It offers structured learning paths, interactive challenges, and professional certifications. Content spans beginner to advanced levels, helping both developers and organizations skill up in cloud native technologies.
80+
<br /><br /><br/>
81+
</p>
82+
<br />
83+
84+
85+
<hr />
86+
<br />
87+
<hr />
5188

5289
<p style="clear:both;">
5390
<h2><a href="https://github.com/service-mesh-patterns">Cloud Native Patterns</a></h2>
5491
<a href="https://github.com/service-mesh-patterns"><img src=".github/assets/images/patterns/service-mesh-pattern.svg" style="float:left;margin:10px;" width="125px" alt="Cloud Native Patterns" align="left"/>
5592
</a>
56-
<a href="https://github.com/service-mesh-patterns">Cloud Native Patterns</a> help you get the most out of Kubernetes and every CNCF project. Each pattern can be used as a template and is customizable.
93+
<a href="https://github.com/service-mesh-patterns">Cloud Native Patterns</a> help you get the most out of Kubernetes and every CNCF project. Each pattern can be used as a template and is customizable. [Site](https://github.io/service-mesh-patterns/service-mesh-patterns)
5794
<br /><br /><br />
5895
</p>
5996
<br />
@@ -110,29 +147,6 @@ alt="Learn Layer5" align="left" />
110147
</p>
111148
<br />
112149

113-
<p style="clear:both;">
114-
<h2><a href="https://layer5.io/projects/nighthawk">Nighthawk</a></h2>
115-
<a href="https://getnighthawk.dev/">
116-
<img src=".github/assets/images/getnighthawk/layer5-getnighthawk.webp"
117-
style="float:left;margin:10px;" width="125px"
118-
alt="Nighthawk" align="left" />
119-
</a>
120-
<a href="https://getnighthawk.dev/">Nighthawk</a> is a Layer 7 (HTTP/HTTPS/HTTP2) performance characterization tool. Nighthawk is Envoy’s load generator and is written in C++. Meshery integrates Nighthawk as one of (currently) three choices of load generator for characterizing and managing the performance of infrastructure and services.
121-
<br /><br /><br />
122-
</p>
123-
124-
125-
126-
<p style="clear:both;">
127-
<h2><a href="https://cloud.layer5.io/catalog">Meshery Catalog</a></h2>
128-
<a href="">
129-
<img src=".github/assets/images/catalog/catalog.svg"
130-
style="float:left;margin:10px;" width="125px"
131-
alt="Meshery Catalog" align="left" />
132-
</a>
133-
<a href="">Meshery Catalog</a> As a central hub for sharing cloud native infrastructure designs, Meshery Catalog enables the exchange of the best practices, reusable templates, and Kubernetes-based operational patterns for multi-cluster Kubernetes clusters and distributed applications. Meshery Catalog serves as a marketplace full of curated cloud native infrastructure configurations and operational patterns perfect for DevOps engineers who seek to leverage and contribute to Meshery's large collection of design patterns.
134-
<br /><br /><br />
135-
</p>
136150

137151
<p style="clear:both;">
138152
<h1><a name="contributing"></a><a name="community"></a> <a href="https://layer5.io/community">Community</a> and <a href="https://layer5.io/community/handbook">Contributions</a></h1>
@@ -162,9 +176,9 @@ alt="Meshery Catalog" align="left" />
162176
</div>
163177
<br />
164178
<ul>
165-
<li>Find us on Twitter: <a href="https://twitter.com/layer5">@layer5</a>, <a href="https://twitter.com/mesheryio">@mesheryio</a>, and <a href="https://twitter.com/smp_spec">@smp_spec</a>.</li>
166-
<li>Visit us on LinkedIn: <a href="https://www.linkedin.com/company/layer5">Layer5</a>, <a href="https://www.linkedin.com/showcase/meshery/">Meshery</a>, and <a href="https://www.linkedin.com/showcase/service-mesh-performance">Cloud Native Performance</a>.</li>
167-
<li>Subscribe on <a href="http://youtube.com/Layer5io?sub_confirmation=1">Youtube</a>.</li>
179+
<li>Find us on Twitter: <a href="https://x.com/layer5">@layer5</a>, <a href="https://x.com/mesheryio">@mesheryio</a>, and <a href="https://x.com/kanvas-new">@kanvas-new</a>.</li>
180+
<li>Visit us on LinkedIn: <a href="https://www.linkedin.com/company/layer5">Layer5</a>, <a href="https://www.linkedin.com/showcase/meshery/">Meshery</a>, and <a href="https://www.linkedin.com/showcase/kanvas-new">Kanvas</a>.</li>
181+
<li>Subscribe on <a href="https://www.youtube.com/Layer5io?sub_confirmation=1">Layer5 Youtube</a>, <a href="https://www.youtube.com/@mesheryio?sub_confirmation=1">Meshery Youtube</a></li>
168182
</ul>
169183

170184
### License

0 commit comments

Comments
 (0)