search

higress-group / higress-group.github.io

Higress Official Website
https://higress.io
Apache License 2.0
17 stars 58 forks source link

优化 hgctl 文档 #200

Open 2456868764 opened 9 months ago

johnlanni commented 9 months ago

一点建议，看是否可以简单调整优化下：

  1. 目前hgctl的功能很多，可以在文档开头列举一下hgctl可以做哪些事情，然后加锚点链接到下面的段落中
  2. 每个功能段落尽量简单，有一个example说明如何使用即可，详细的可以让用户看help命令的输出
  3. profile的说明比较复杂，大部分用户使用默认的最佳实践配置即可，其实不需要关心，建议放在文章最后
2456868764 commented 9 months ago

一点建议，看是否可以简单调整优化下：

  1. 目前hgctl的功能很多，可以在文档开头列举一下hgctl可以做哪些事情，然后加锚点链接到下面的段落中
  2. 每个功能段落尽量简单，有一个example说明如何使用即可，详细的可以让用户看help命令的输出
  3. profile的说明比较复杂，大部分用户使用默认的最佳实践配置即可，其实不需要关心，建议放在文章最后

OK