This repository contains the documentation for the Alauda Service Mesh v2.
Before you begin, make sure you have the following installed on your system:
- Clone this repository and navigate to the project directory
- Install project dependencies:
yarn installFor the best development experience, we recommend:
- Editor: Visual Studio Code
- Extension: MDX extension for enhanced markdown editing
| Command | Description |
|---|---|
yarn dev |
Start development server with hot reload |
yarn build |
Build production-ready static files |
yarn serve |
Preview built files locally |
- Start development: Run
yarn devto launch the local server - Edit content: Make changes to your markdown files - they'll update automatically
- Navigation changes: If you modify the sidebar navigation, restart the development server
- Preview production: Use
yarn buildfollowed byyarn serveto test the final build
💡 Tip: The development server supports hot reloading for most changes, making your workflow smooth and efficient!
使用如下脚本更新 docs/en/integration/observability/kiali.mdx 中的 Kiali 版本:
# 用法: ./hack/update-kiali-in-docs.sh <NEW_VERSION> <OLD_VERSION>
./hack/update-kiali-in-docs.sh 2.27.1-rc.0 2.22.2
./hack/update-kiali-in-docs.sh 2.27.1-r0 2.27.1-rc.0让 AI 读取当前版本到新版本更新的内容:https://kiali.io/news/release-notes/。 然后分析当前文档是否有需要同步更新的部分,review 后执行更新。
因为 Mesh 维护两个 Istio 大版本,所以使用如下脚本先修改最新版本,然后是次新版本:
# 用法: ./update-istio-in-docs.sh <NEW_VERSION> <OLD_VERSION>
./hack/update-istio-in-docs.sh 1.28.1 1.26.3
./hack/update-istio-in-docs.sh 1.26.3 1.24.6让 AI 读取当前版本到新版本更新的内容:
- https://github.com/istio-ecosystem/sail-operator/releases
https://istio.io/latest/news/releases/1.<version>.x/announcing-1.<version>/(修改为对应版本)
然后分析当前文档是否有需要同步更新的部分,review 后执行更新。
更新 sites.yaml 中的最新外链站点。