Contributing to Layer5 Docs

Mon, 01 Jan 0001 00:00:00 +0000

Welcome to the GitHub repository for Layer5’s documentation website!

The docs website is hosted at https://docs.layer5.io.

We use Hugo with the google/docsy theme for styling and site structure, and Netlify to manage the deployment of the site.

Quickstart 🔗

Here’s a quick guide to updating the docs:

Fork the layer5io/docs repository on GitHub.
Make your changes and send a pull request (PR).
If you’re not yet ready for a review, add “WIP” to the PR name to indicate it’s a work in progress.

Contributing to Video Gallery

Mon, 01 Jan 0001 00:00:00 +0000

Note

In Hugo, a section is a directory containing an _index.md file.

Overview 🔗

Contributing videos involves either:

Creating a category → subcategory → adding video markdown files, or
Adding video markdown files directly under a category (these will automatically be assigned to an “ALL” subcategory)

1. Creating a Category 🔗

To create a top-level category:

Create a directory under content/en/videos (e.g., getting-started)
Add an _index.md file inside this directory with the following frontmatter:

title: Getting Started # Category text appearing in the /videos category tab and left sidebar
description: >
 Getting started videos on Cloud and Kanvas
weight: 2 # Order in which this category appears in the /videos page and left sidebar
icon: bi-rocket-takeoff-fill # Icon for the category (supports Bootstrap icons and local/remote assets)
videoGrid: true # When true, shows all child / nested videos as a grid of cards on this section's index page
 # When false, presents a hyperlinked list of videos/sub-sections instead

draft: true # When true, previews this section on local dev server but hides from left sidebar and /videos landing page on published site

2. Adding Videos to Your Category 🔗

There are two approaches for adding videos: