apache / shenyu-website

Apache ShenYu website.
https://shenyu.apache.org/
Apache License 2.0
73 stars 219 forks source link

[DOC] update helm deployment doc for prerequisites and version #828

Closed aFlyBird0 closed 1 year ago

aFlyBird0 commented 1 year ago

Signed-off-by: Bird aflybird0@gmail.com

  1. 更新安装工具链接
  2. 填补之前漏掉的几个配置说明
  3. 文档增加版本。不同于其他项目,Helm的文档版本做了些改动:
    • 没有 "next" 版本,目前每改一次就发一次版,所以都是先release再改文档。或许以后可以把改动和发版分开。目前apisix是在积攒了一定的改动后,手动改一下chart.yaml的版本号然后发版,jenkinsci是每次改动都发版。prometheus也是只要对chart做了改动就发版
    • 不是一个 "chart版本" 一个文档,chart发版肯定远快于 shenyu 本身,所以一个 shenyu 版本对应 n 个 chart 版本,所以一个chart文档目前设计的对应n个shenyu版本,并且只维护最新版的chart的文档。(其他的通过兼容性保证)

下面是prometheus的关于chart版本的要求:

image

https://github.com/prometheus-community/helm-charts/blob/main/CONTRIBUTING.md#technical-requirements