You want to contribute to the project? Yay! We want you to! Visit our centralized instructions for contributing.
Contributions, updates, discrepancy reports and pull requests are welcome! Layer5 is community-built and warmly welcomes collaboration. Contributors are expected to adhere to the Contributor Covenant code of conduct.
The service mesh landscape is powered by Jekyll. In order to add/update the landscape, clone this repository, create a branch and navigate to the _data/categories folder. Edit these yaml files (if appropriate):
- non-functional.yml - overview of various service meshes
- meshes.yml - list of individual service mesh details
- proxies.yml - list of individual modern proxies
- gw.yml - list of API gateways
- lb.yml - list of load balancers
Entries should be listed in alphabetical order. Edit other yaml files as needed.
Please contribute! The Layer5 site uses GitHub Pages (Jekyll) to host its site. The process of contributing to documentation follows this flow:
- Get a local copy of the site.
git clone https://github.com/layer5io/layer5 - Create and checkout a new branch to make changes within
git checkout -b <my-username>/<my-changes> - Edit site/add content.
vi <specific page>.md# or use your favorite IDE - Run site locally to preview changes.
make site# this will run a local web server with "live reload" conveniently enabled. - Commit and push changes to your remote branch.
git push origin <my-username>/<my-changes> - Open a pull request (in your web browser) against the master branch on https://github.com/layer5io/layer5.
Build and preview your changes by running make site or make docker.