Preview of Meshery.io Website
Visit Meshery.io to learn more!
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.
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 are experienced 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 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.
Before contributing, please review the Contribution Flow and this repository's CONTRIBUTING.md. 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.
-
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 Ruby 3.2.2 or newer, as specified in the Gemfile )
-
If your installed Ruby version is older than the minimum specified in the Gemfile, you can use RVM to install a compatible version for your operating system.
-
Windows contributors: Note that
makeis required if you want to use themake sitecommand; alternatively, you can run Jekyll directly via Bundler withoutmake(see Windows Notes).
- Fork and then clone the Meshery.io repository
$ git clone https://github.com/YOUR-USERNAME/meshery.io
- cd into project using
$ cd meshery.io
- Serve the code locally
Note: The Makefile prefers Docker (if available and the daemon is running) and will run Jekyll inside the official jekyll container. If Docker isn't running, the Makefile will only serve locally if required gems are already installed; otherwise it will prompt to start Docker or run
$ make site
bundle install --path vendor/bundle.
- Install the dependencies (requires Node.js 20 or newer) and run the linters before committing
$ npm ci
$ make lint- To automatically fix lint issues
$ make lint-fixNote: make lint compares your branch against upstream/master (or origin/master if you have no upstream remote), so run git fetch upstream (or git fetch origin) first. ESLint checks only changed JavaScript files, and errors fail the check. Prettier checks only CSS/SCSS files under _sass/ and css/: newly added files must be formatted, and errors fail the check. Existing files in those folders only show a non-blocking formatting warning (Prettier errors such as syntax errors still fail) and are never modified by make lint-fix.
On Windows, run make lint and make lint-fix from Git Bash or WSL, since the Makefile uses POSIX shell syntax.
On Windows (such as when using Git Bash), make is not included by default and running make site may result in bash: make: command not found. Windows contributors can use either of these options:
- Option 1: Run Jekyll directly (no
makerequired)$ bundle install --path vendor/bundle $ bundle exec jekyll serve --drafts --incremental --livereload --config _config_dev.yml - Option 2: Install
makeon Windows Installmakeusing a package manager such as Chocolatey (choco install make), Scoop (scoop install make), or Winget (winget install GnuWin32.Make). Once installed and in your PATH, you can runmake sitenormally.
- 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.
If you like Meshery, please ★ star this repository to show your support! 🤩
This repository and site are available as open source under the terms of the Apache 2.0 License.