Merge branch 'sidecar' of https://github.com/seeflood/layotto into si…

…decar
mosn · Jul 28, 2022 · 37d5750 · 37d5750
2 parents 511b75d + a1ed135
commit 37d5750
Show file tree

Hide file tree

Showing 6 changed files with 100 additions and 91 deletions.
diff --git a/.github/dead_link_check_config.json b/.github/dead_link_check_config.json
@@ -12,6 +12,9 @@
     {
       "pattern": "^https://console.cloud.tencent.com/cos/bucket"
     },
+    {
+      "pattern": "^https://docs.buf.build/"
+    },
     {
       "pattern": "^#"
     }

diff --git a/README.md b/README.md
@@ -126,7 +126,7 @@ Layotto enriches the <a href="https://landscape.cncf.io/serverless">CNCF CLOUD N
 
 | Platform                                               | Link                                                                                                                                                                           |
 | :----------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 💬 [DingTalk](https://www.dingtalk.com/en) (preferred) | Search the group number: 31912621 or scan the QR code below <br> <img src="https://raw.githubusercontent.com/mosn/layotto/main/docs/img/ding-talk-group-1.png" height="200px"> |
+| 💬 [DingTalk](https://www.dingtalk.com/en) (preferred) | Search the group number: 31912621 or scan the QR code below <br> <img src="https://gw.alipayobjects.com/mdn/rms_5891a1/afts/img/A*HUKsSrFthtUAAAAAAAAAAAAAARQnAQ" height="200px"> |
 
 [comment]: <> (| 💬 [Wechat]&#40;https://www.wechat.com/en/&#41; | Scan the QR code below and she will invite you into the wechat group <br> <img src="/img/wechat-group.jpg" height="200px">)
 

diff --git a/docs/en/README.md b/docs/en/README.md
@@ -124,7 +124,7 @@ Layotto enriches the <a href="https://landscape.cncf.io/serverless">CNCF CLOUD N
 
 | Platform                                               | Link                                                                                                                                                                                    |
 | :----------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 💬 [DingTalk](https://www.dingtalk.com/en) (preferred) | Search the group number: 31912621 or scan the QR code below <br> <img src="https://gw.alipayobjects.com/mdn/rms_5891a1/afts/img/A*--KAT7yyxXoAAAAAAAAAAAAAARQnAQ" height="200px"> |
+| 💬 [DingTalk](https://www.dingtalk.com/en) (preferred) | Search the group number: 31912621 or scan the QR code below <br> <img src="https://gw.alipayobjects.com/mdn/rms_5891a1/afts/img/A*HUKsSrFthtUAAAAAAAAAAAAAARQnAQ" height="200px"> |
 
 [comment]: <> (| 💬 [Wechat]&#40;https://www.wechat.com/en/&#41; | Scan the QR code below and she will invite you into the wechat group <br> <img src="img/wechat-group.jpg" height="200px">)
 

diff --git a/docs/en/api_reference/comment_spec_of_proto.md b/docs/en/api_reference/comment_spec_of_proto.md
@@ -5,7 +5,8 @@ Avoid adding empty lines between comments  symbols `//`.If there is a blank line
 bad case:
 
 ```
-message  BadCase{
+// XXXXXXXX
+message BadCase{
   // XXXXXXXX
   //
   // XX
@@ -18,7 +19,8 @@ message  BadCase{
 good case:
 
 ```
-message  GoodCase{
+// XXXXXXXX
+message GoodCase{
   // XXXXXXXX
   // XX
   // XXXXXX
@@ -32,6 +34,8 @@ Or you can use another annotation symbol directly `/*  */`
 If you want to have some comment in your proto files, but don't want them to be part of the docs, you can simply prefix the comment with `@exclude`.
 Example: include only the comment for the id field
 
+Attention: `/*  */` comments do not count towards passing ci `Proto Validation`. [refence](https://docs.buf.build/lint/rules#comments)
+
 ```
 /**
  * @exclude
@@ -40,8 +44,7 @@ Example: include only the comment for the id field
 message ExcludedMessage {
   string id   = 1; // the id of this message.
   string name = 2; // @exclude the name of this message
-
   /* @exclude the value of this message. */
   int32 value = 3;
 }
-```
+```