Kmesh Docs & Website

This repo contains the source code of Kmesh Website and all of the docs for Kmesh.

• Kmesh Website
• Kmesh Docs
• Kmesh Blog

Welcome to join us and you are more than appreciated to contribute!

Quick Start

Here's a quick guide to updating the docs. It assumes you're familiar with the GitHub workflow and you're happy to use the automated preview of your doc updates:

1. Fork the Kmesh/website repo on GitHub.
2. Make your changes and send a pull request (PR).
3. If you're not yet ready for a review, add a comment to the PR saying it's a work in progress or add [WIP] in your PRs title. You can also add /hold in a comment to mark the PR as not ready for merge.
4. Wait for the automated PR workflow to do some checks. When it's ready, you should see a comment like this: Deploy Preview for kmesh-net ready!
5. Click Details to the right of "Deploy preview ready" to see a preview of your updates.
6. Continue updating your doc until you're happy with it.
7. When you're ready for a review, add a comment to the PR and assign a reviewer/approver. See the Kmesh contributor guide.

---

How to Install

The Kmesh website is built using the Hugo static site generator. Follow these steps to install and run it:

1. Prerequisites

• Ensure you have the specific version of Hugo: hugo_extended_0.90.0.
• Download the required version based on your operating system: Hugo Releases.

2. Installation Steps

1. Download the appropriate hugo_extended_0.90.0 binary for your operating system.
2. Extract the downloaded archive (if compressed).
3. Add the hugo binary to your system's PATH:
   • Linux/macOS: Move the binary to /usr/local/bin/.
   • Windows: Add the folder containing the binary to your system's environment variables.

3. Verify Installation

Run the following command to confirm the installed version:

hugo version

Ensure the output matches hugo_extended_0.90.0.

4. Running the Hugo Server

To build and serve the site locally, use the following commands:

Basic Build

hugo

This builds the site and places the output in the public directory.

Serve Locally

hugo server

Access the local site at: http://localhost:1313

---

Notes of Writing Documentation

In the Kmesh documentation, a note is required at the beginning of each document as follows:

---
draft: false
linktitle: XXX
menu:
  docs:
    parent: XXX
    weight: 1
title: XXX
toc: true
type: docs

---

There are four points to note:

• linktitle is the title displayed in the menu.
• title is the title displayed on the document page.
• parent indicates which directory this document is contained in. For example, if you want to write a document under the user guide, you need to set the parent: user guide. For the correspondence of each menu, please refer to menus. A simpler way is to directly copy the configuration of the existing documents in the directory.
• weight is used to order the documents. Should avoid duplication and conflicts prevented. It is also best not to use adjacent numbers to facilitate the insertion of new documents. A spacing of 5 is recommended. If you want your document to always be at the end of the current directory, you can just use 99.