Write with Layer5!
What is Layer5 Writing Program?
The Layer5 Writing Program is a way to demonstrate your expertise, give back to the community, and help us produce great content. We collaborate with authors and technologists from around the world to produce high quality articles, blog posts, tutorials and other cloud native resources on Meshery, Kubernetes, service meshes, Docker and related technologies.
Why should you participate?
Improve your writing and Publishing is a feedback-driven process that can help you understand your audience better, explain complex topics clearly, and iterate to improve results. Become a better technical writer by collaborating with an accomplished team of technical writers and editors. | |
Build your technical profileShare your knowledge with a worldwide developer community. Build your GitHub profile with assigned issues and merged pull requests. Articles, posts, project documentation written by you will be drafted, put into a pull request, reviewed and merged like any other code-centric contribution. Documenting the problems you solved or a new feature you implemented will serve as a perpetual guide to others in the community. |
Establish your voice and personal brandSharing your knowledge not only demonstrates your technical expertise, it highlights your ability to teach others, and establishes you as an authority on the topic. Your technical write-ups are empirical evidence of your ability to learn and teach. | |
EducateWhether you're writing about a complex system or a a set of actions you took to address an error, the odds are high that someone else will someday struggle with the same things as you. By writing about the things that you learn or find interesting, you aren't just teaching yourself, you're also helping share your knowledge with every person who reads your post. |
Where can you contribute?
We welcome the contribution of any type that shares knowledge about our projects or related technologies.
Do you want to document your recent effort in implementing a new feature? Do you want to share a solution for a problem you were struggling with? Do you want to share information about a recent technology you find intriguing? Want to host an event with Layer5? Want to deliver a talk, a workshop, or a tutorial? Just let us know.
What is the process?
If you’re interested in the Layer5 Writing Program, please submit your information (and proposed topic, if you have one) to get started. Don't have a topic? Don't worry, we have plenty of suggestions for you.
Upon being accepted, you'll work with a coordinator on the content team to decide on a topic, develop a project plan, and discuss submission details.
What are some suggested topics?
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 / Slack Channel.
DevOps/Observability/Kubernetes:
Distributed Tracing in Context of Meshery's Architecture.
One-stop Cloud Native Market Place - Meshery Catalog.
Interpreting your Cloud Native Performance - SMP.
Creating and Deploying your first application with Kanvas.
Load generation and Load balancing.
DevOps and Platform Engineering.
Beginners guide to Meshmodel.
Enhancing Microservices Observability with Meshery and Prometheus.
Community:
Building Bridges, Not Walls: The Power of Open Source Collaboration.
A Deep Dive into Meshery's Contribution to Cloud Native Ecosystem.
Open Source Sustainability: Funding Models for Long-Term GitHub Projects.
Importance to an open source community.
Beyond Code: The Unsung Heroes of Open Source - Documenters, Testers, and Designers.
Open Source Alchemy: Transforming Community Contributions into Gold.
Collaborative Open Source Development: Inside the Community of Layer5.
How to Submit and Review Your Writing?
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.
Google Docs Review:
If you prefer a straightforward approach, start by crafting your blog article within Google Docs, ensuring it's well-structured and error-free. Share the document with us by adding it to the Community Drive, 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.
Website Contribution Review:
For those comfortable with local website development, contribute directly to the community website. Set up your local environment, create a blog post adhering to specified guidelines, and submit it via a Pull Request on GitHub. 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.
Additional Resources
