Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kmesh-net/website
Kmesh website and documentation repo
https://github.com/kmesh-net/website
Last synced: about 1 month ago
JSON representation
Kmesh website and documentation repo
- Host: GitHub
- URL: https://github.com/kmesh-net/website
- Owner: kmesh-net
- License: cc-by-4.0
- Created: 2023-07-15T04:00:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-20T02:47:50.000Z (about 1 month ago)
- Last Synced: 2024-11-20T03:26:10.093Z (about 1 month ago)
- Language: SCSS
- Homepage: https://kmesh.net
- Size: 10.1 MB
- Stars: 2
- Watchers: 2
- Forks: 13
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kmesh Docs & Website
This repo contains the source code of [Kmesh Website](https://kmesh.net/en/) and all of the docs for Kmesh.
- [Kmesh Website](https://kmesh.net/en/)
- [Kmesh Docs](https://kmesh.net/en/docs/)
- [Kmesh Blog](https://kmesh.net/en/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](https://github.com/kmesh-net/website) 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](https://github.com/kmesh-net/kmesh/blob/main/CONTRIBUTING.md).
## Notes of Writing Documentation
In the Kmesh documentation, a note is required at the beginning of each document as follows:
```console
---
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](./config/_default/menus.toml).
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.