Layer5 Product Documentation
Explore tutorials and documentation by product in the docs.layer5.io website; documentation and developer resources of Layer5 products.
Contributions Welcome!
If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in 🚀
Running the Site Locally
The website can be run locally through Golang (Hugo) or Docker. If you choose to run through Docker, everything will be a little bit slower due to the additional overhead, so for frequent contributors it may be worth it to use Golang.
With Docker
Running the site locally is simple. Provided you have Docker installed, clone this repo, run make docker, and then visit http://localhost:3000.
The docker image is pre-built with all the website dependencies installed, which is what makes it so quick and simple, but also means if you need to change dependencies and test the changes within Docker, you'll need a new image. If this is something you need to do, you can run make build-image to generate a local Docker image with updated dependencies, then make website-local to use that image and preview.
With Golang
If your local development environment has a supported version (v1.21.0+) of Golang installed, next you'll need to install extended hugo version as it has necessary SCSS/SASS support. Find all the hugo packages here: https://github.com/gohugoio/hugo/releases/tag/v0.120.4
Now to setup and run the site locally run:
make setup followed by make site
...and then visit http://localhost:1313.
If you pull down new code from GitHub, you will occassionally need run make setup again. Otherwise, there's no need to re-run make setup each time the site is run, you can just run make site to get it going and have it automatically reload as you make and save site edits.
Editing Markdown Content
Documentation content is written in Markdown and you'll find all files listed under the /content directory.
To create a new page with Markdown, create a file ending in .md in a site/<subdirectory>. The path in the content directory will be the URL route. For example, site/docs/hello.md will be served from the /docs/hello URL.
---
title: 'My Title'
description: "A thorough, yet succinct description of the page's contents"
---The significant keys in the YAML frontmatter are:
title (string) - This is the title of the page that will be set in the HTML title.
description (string) - This is a description of the page that will be set in the HTML description.
permalink (string - relative file path) - canoncial location of the page
category (string) - section to which the page belongs.
redirect_from (string - relative file path) - in case the page was previously available elsewhere
Uploading Images to the site
To display images in a pop-up modal, use the following syntax: .
Note-> For images to show correctly on subpages, always provide the complete image path
Our projects are community-built and welcome collaboration. 👍 Be sure to see the Layer5 Community Welcome Guide for a tour of resources available to you and jump into our Slack!
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 on the Layer5 community.
✔️ Join any or all of the weekly meetings on community calendar.
✔️ Watch community meeting recordings.
✔️ Access the Community Drive by completing a community Member Form.
✔️ Discuss in the Community Forum.
✔️Explore more in the Community Handbook.
Not sure where to start? Grab an open issue with the help-wanted label.