Skip to content

Latest commit

 

History

History
149 lines (104 loc) · 8.42 KB

README.md

File metadata and controls

149 lines (104 loc) · 8.42 KB
Raw

Shows an illustrated light mode meshery logo in light color mode and a dark mode meshery logo dark color mode.



Meshery.io

Docker Pulls Go Report Card Build Status GitHub GitHub issues by-label Website Twitter Follow Discuss Users Slack CII Best Practices

Preview of Meshery.io Website

Meshery.io website screenshot Visit Meshery.io to learn more!

What is Meshery?

Meshery is a self-service engineering platform - the open source, cloud native manager that enables the design and management of all Kubernetes-based infrastructure and applications. Among other features, Meshery manages multi-cluster Kubernetes deployments. As an extensible platform, Meshery offers visual and collaborative GitOps, freeing you from the chains of YAML.

For further information, refer to the Meshery Docs.

 

Join the Meshery community!

Our projects are community-built and welcome collaboration. 👍 Be sure to see the Newcomers' Guide for a tour of resources available to you and jump into our Slack to engage!

MeshMates

Find your MeshMate

MeshMates are experienced Layer5 community members, who will help you learn your way around, discover live projects and expand your community network. Become a Meshtee today!

Find out more about the Layer5 community.




Shows an illustrated light mode meshery logo in light color mode and a dark mode meshery logo dark color mode.

Meshery Community

✔️ Join any or all of the weekly meetings on the community calendar.
✔️ Watch community meeting recordings.
✔️ Access the Community Drive-by completing a community Member Form.
✔️ Discuss in the Community Forum.
✔️ RSVP to the CNCF Meshery Community meetings.

Not sure where to start? Grab an open issue with the help-wanted label.

 

Contributing to the Meshery.io Website

Before contributing, please review the Contribution Flow. In the following steps, you will setup your development environment, fork and clone the repository, run the site locally, and finally commit, sign off, and push any changes made for review.

1. Set up your development environment

  • The Meshery site is built using Jekyll - a simple static site generator! You can learn more about Jekyll and setting up your development environment in the Jekyll Docs.

  • First install Ruby, then install Jekyll and Bundler. ( Note : Install the same version of Ruby as mentioned in the Gemfile )

2. Get the code

  • Fork and then clone the Meshery.io repository 
    $ git clone https://github.com/YOUR-USERNAME/meshery.io
  • cd into project using 
    $ cd meshery.io
  • Install any Ruby dependencies 
    $ bundle install

3. Serve the site

  • Serve the code locally 
    $ make site
    Note: From the Makefile, this command is actually running $ bundle exec jekyll serve --drafts --livereload

4. Create a Pull Request

  • After making changes, don't forget to commit with the sign-off flag (-s)! 
    $ git commit -s -m “my commit message w/signoff”
  • Once all changes have been committed, push the changes. 
    $ git push origin <branch-name>
  • Then on Github, navigate to the Meshery.io repository and create a pull request from your recently pushed changes!

Add your content to the cloud native catalog.

To add your content to the Cloud Native Catalog -

  1. Create a new file in the catalog collection, under the respective type.
  2. Follow the template in the _defaults.md and fill out the details.
  3. Add your pattern file to the catalog folder so that others can download the file.
  4. That's it! You're good to go. Create a PR for your change and sit tight till a maintainer gets a chance to review it.

License

This repository and site are available as open source under the terms of the Apache 2.0 License.