Contributing To Meshery Docs
Jekyll
Getting Started with Meshery Docs
👩💻 Set up your environment
- Follow the official guide to fork the repo and run the site locally (make docs).�- Sign off your commits with git commit -s -m "...".
👀 Preview and Contribute
- Run the site locally, check your changes.
- Push your branch and open a pull request (PR) on GitHub.
- Wait for deploy preview and review your update again.
⚙️Docs Structure & Features
Sections:
Overview & Installation
Concept
Guides & Tutorials
Integration & Extension
Community & Contribution
Reference & Extensibility
Features:
Clipboard Feature
Alerts
Image Handling
Quotes
Notes: We have two docs: Layer5 & Meshery. This talk focuses on Meshery, but the process is similar.
How Docs Work – Rendering and Structure
🧠 What powers the docs
YAML frontmatter
– for page metadata like layout, title, URL
Liquid
– Jekyll templating syntax
Jekyll
– static site generator used in Meshery Docs
💻 Layout example
�/docs/pages/project/contributing/example.md
/docs/_data/toc.yml
/docs/_layouts/page.html
🧩 How a Meshery Docs Page is Rendered
1. Markdown page (`example.md`)
- Starts with YAML frontmatter
- Declares: `layout: page`
2. `page.html` layout
- Injects `{{ content }}`
- Adds clipboard script, optional TOC
3. `default.html` layout
- Provides full HTML structure:
- Sidebar, breadcrumbs, header, footer
- Content area, editable links, feedback
📌 Flow:
`example.md` → `page.html` → `default.html` → final webpage
Writing Tips & Resources
✍️ Writing Tips
Use active voice�"You can configure Meshery" ✔️
"Meshery can be configured"❌
Keep it short and clear�If you write long blocks of text, consider:
Breaking into paragraphs
Adding images
Using info alert blocks�
Stay consistent with terms�Decide if you want to say “users” or “you” and apply it everywhere.
Contributor Training Series
Meshery Docs
Zihan Kuang
Software Intern
layer5.io/community/members/zihan-kuang
Contributor Training Series
E2E Testing in Meshery CLI
Riya Garg
Contributor
layer5.io/community/members/riya-garg
Contributor Training Series
Meshery UI
Amit Amrutiya
Maintainer, UI
layer5.io/community/members/amit-amrutiya
Contributor Training Series
E2E Testing in Meshery UI
Ian Whitney
Contributor
layer5.io/community/members/ian-whitney
Contributor Training Series
Meshery CI
Sangram Rath
Maintainer, CI
layer5.io/community/members/sangram-rath
Contributor Training Series
Meshery Models
Aabid Sofi
Maintainer, UI
layer5.io/community/members/aabid-sofi
Contributor Training Series
Meshery Server
Shlok Mishra
Contributor
layer5.io/community/members/shlok-mishra
Contributor Training Series
Meshery CLI
Aadhitya A.
Matthieu Evrin
Maintainer, CLI
Maintainer, CLI
layer5.io/community/members/aadhitya-amarendiran
layer5.io/community/members/matthieu-evrin
Getting Started With
Meshery Models
Aabid Sofi
Sangram Rath
Maintainer, UI
Maintainer, CI
layer5.io/community/members/aabid-sofi
layer5.io/community/members/sangram-rath
Aabid Sofi
CONTRIBUTOR TRAINING SERIES�
Meshery Models
Maintainer, UI
layer5.io/community/members/aabid-sofi