Merge pull request #448 from Peefy/fix-tour-protocol-examples

fix: tour protocol examples
kcl-lang · Aug 22, 2024 · 07a93fd · 07a93fd
2 parents 139b067 + fcad80f
commit 07a93fd
Show file tree

Hide file tree

Showing 16 changed files with 120 additions and 120 deletions.
diff --git a/docs/reference/lang/tour.md b/docs/reference/lang/tour.md
@@ -2700,26 +2700,26 @@ We can use protocol to implement type checking of rule structure:
 
 ```python
 # Protocol definition
-protocol Service:
+protocol ServiceProtocol:
     clusterIp: str
     $type: str
 
 # Protocol definition
-protocol Volume:
-    mountPath: [str]
+protocol VolumeProtocol:
+    mountPath: str
 
 # Protocol
 protocol SomeProtocol:
     id: int
     env: {str: any}
-    services: [Service]
-    volumes: [Volume]
+    services: [ServiceProtocol]
+    volumes: [VolumeProtocol]
 
 rule SomeChecker for SomeProtocol:
     id > 0, "id must >0"
 
     all service in services {
-        service.clusterIP == "NONE" if service.type == "ClusterIP"
+        service.clusterIp == "NONE" if service.type == "ClusterIP"
     }
 
     any volume in volumes {
@@ -2735,7 +2735,7 @@ SomeChecker {
     services = [
         {
             type = "ClusterIP"
-            clusterIP = "NONE"
+            clusterIp = "NONE"
         }
     ]
     volumes = [

diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/lang/tour.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/lang/tour.md
@@ -2633,26 +2633,26 @@ rule2 = SomeRule {}
 
 ```python
 # Protocol definition
-protocol Service:
+protocol ServiceProtocol:
     clusterIp: str
     $type: str
 
 # Protocol definition
-protocol Volume:
-    mountPath: [str]
+protocol VolumeProtocol:
+    mountPath: str
 
 # Protocol
 protocol SomeProtocol:
     id: int
     env: {str: any}
-    services: [Service]
-    volumes: [Volume]
+    services: [ServiceProtocol]
+    volumes: [VolumeProtocol]
 
 rule SomeChecker for SomeProtocol:
     id > 0, "id must >0"
 
     all service in services {
-        service.clusterIP == "NONE" if service.type == "ClusterIP"
+        service.clusterIp == "NONE" if service.type == "ClusterIP"
     }
 
     any volume in volumes {
@@ -2668,7 +2668,7 @@ SomeChecker {
     services = [
         {
             type = "ClusterIP"
-            clusterIP = "NONE"
+            clusterIp = "NONE"
         }
     ]
     volumes = [

diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.10/reference/lang/tour.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.10/reference/lang/tour.md
@@ -2633,26 +2633,26 @@ rule2 = SomeRule {}
 
 ```python
 # Protocol definition
-protocol Service:
+protocol ServiceProtocol:
     clusterIp: str
     $type: str
 
 # Protocol definition
-protocol Volume:
-    mountPath: [str]
+protocol VolumeProtocol:
+    mountPath: str
 
 # Protocol
 protocol SomeProtocol:
     id: int
     env: {str: any}
-    services: [Service]
-    volumes: [Volume]
+    services: [ServiceProtocol]
+    volumes: [VolumeProtocol]
 
 rule SomeChecker for SomeProtocol:
     id > 0, "id must >0"
 
     all service in services {
-        service.clusterIP == "NONE" if service.type == "ClusterIP"
+        service.clusterIp == "NONE" if service.type == "ClusterIP"
     }
 
     any volume in volumes {
@@ -2668,7 +2668,7 @@ SomeChecker {
     services = [
         {
             type = "ClusterIP"
-            clusterIP = "NONE"
+            clusterIp = "NONE"
         }
     ]
     volumes = [

diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.4/reference/lang/tour.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.4/reference/lang/tour.md
@@ -2558,27 +2558,27 @@ rule2 = SomeRule {}
 可以使用 protocol 和 for 绑定语句为 rule 增加类型约束:
 
 ```python
-# Schema definition
-protocol Service:
+# Protocol definition
+protocol ServiceProtocol:
     clusterIp: str
     $type: str
 
-# Schema definition
-protocol Volume:
-    mountPath: [str]
+# Protocol definition
+protocol VolumeProtocol:
+    mountPath: str
 
 # Protocol
 protocol SomeProtocol:
     id: int
     env: {str: any}
-    services: [Service]
-    volumes: [Volume]
+    services: [ServiceProtocol]
+    volumes: [VolumeProtocol]
 
 rule SomeChecker for SomeProtocol:
     id > 0, "id must >0"
 
     all service in services {
-        service.clusterIP == "NONE" if service.type == "ClusterIP"
+        service.clusterIp == "NONE" if service.type == "ClusterIP"
     }
 
     any volume in volumes {
@@ -2594,7 +2594,7 @@ SomeChecker {
     services = [
         {
             type = "ClusterIP"
-            clusterIP = "NONE"
+            clusterIp = "NONE"
         }
     ]
     volumes = [

diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5/reference/lang/tour.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.5/reference/lang/tour.md
@@ -2567,27 +2567,27 @@ rule2 = SomeRule {}
 可以使用 protocol 和 for 绑定语句为 rule 增加类型约束:
 
 ```python
-# Schema definition
-protocol Service:
+# Protocol definition
+protocol ServiceProtocol:
     clusterIp: str
     $type: str
 
-# Schema definition
-protocol Volume:
-    mountPath: [str]
+# Protocol definition
+protocol VolumeProtocol:
+    mountPath: str
 
 # Protocol
 protocol SomeProtocol:
     id: int
     env: {str: any}
-    services: [Service]
-    volumes: [Volume]
+    services: [ServiceProtocol]
+    volumes: [VolumeProtocol]
 
 rule SomeChecker for SomeProtocol:
     id > 0, "id must >0"
 
     all service in services {
-        service.clusterIP == "NONE" if service.type == "ClusterIP"
+        service.clusterIp == "NONE" if service.type == "ClusterIP"
     }
 
     any volume in volumes {
@@ -2603,7 +2603,7 @@ SomeChecker {
     services = [
         {
             type = "ClusterIP"
-            clusterIP = "NONE"
+            clusterIp = "NONE"
         }
     ]
     volumes = [

diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.6/reference/lang/tour.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.6/reference/lang/tour.md
@@ -2609,26 +2609,26 @@ rule2 = SomeRule {}
 
 ```python
 # Protocol definition
-protocol Service:
+protocol ServiceProtocol:
     clusterIp: str
     $type: str
 
 # Protocol definition
-protocol Volume:
-    mountPath: [str]
+protocol VolumeProtocol:
+    mountPath: str
 
 # Protocol
 protocol SomeProtocol:
     id: int
     env: {str: any}
-    services: [Service]
-    volumes: [Volume]
+    services: [ServiceProtocol]
+    volumes: [VolumeProtocol]
 
 rule SomeChecker for SomeProtocol:
     id > 0, "id must >0"
 
     all service in services {
-        service.clusterIP == "NONE" if service.type == "ClusterIP"
+        service.clusterIp == "NONE" if service.type == "ClusterIP"
     }
 
     any volume in volumes {
@@ -2644,7 +2644,7 @@ SomeChecker {
     services = [
         {
             type = "ClusterIP"
-            clusterIP = "NONE"
+            clusterIp = "NONE"
         }
     ]
     volumes = [

diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.7/reference/lang/tour.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.7/reference/lang/tour.md
@@ -2623,26 +2623,26 @@ rule2 = SomeRule {}
 
 ```python
 # Protocol definition
-protocol Service:
+protocol ServiceProtocol:
     clusterIp: str
     $type: str
 
 # Protocol definition
-protocol Volume:
-    mountPath: [str]
+protocol VolumeProtocol:
+    mountPath: str
 
 # Protocol
 protocol SomeProtocol:
     id: int
     env: {str: any}
-    services: [Service]
-    volumes: [Volume]
+    services: [ServiceProtocol]
+    volumes: [VolumeProtocol]
 
 rule SomeChecker for SomeProtocol:
     id > 0, "id must >0"
 
     all service in services {
-        service.clusterIP == "NONE" if service.type == "ClusterIP"
+        service.clusterIp == "NONE" if service.type == "ClusterIP"
     }
 
     any volume in volumes {
@@ -2658,7 +2658,7 @@ SomeChecker {
     services = [
         {
             type = "ClusterIP"
-            clusterIP = "NONE"
+            clusterIp = "NONE"
         }
     ]
     volumes = [

diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.8/reference/lang/tour.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.8/reference/lang/tour.md
@@ -2623,26 +2623,26 @@ rule2 = SomeRule {}
 
 ```python
 # Protocol definition
-protocol Service:
+protocol ServiceProtocol:
     clusterIp: str
     $type: str
 
 # Protocol definition
-protocol Volume:
-    mountPath: [str]
+protocol VolumeProtocol:
+    mountPath: str
 
 # Protocol
 protocol SomeProtocol:
     id: int
     env: {str: any}
-    services: [Service]
-    volumes: [Volume]
+    services: [ServiceProtocol]
+    volumes: [VolumeProtocol]
 
 rule SomeChecker for SomeProtocol:
     id > 0, "id must >0"
 
     all service in services {
-        service.clusterIP == "NONE" if service.type == "ClusterIP"
+        service.clusterIp == "NONE" if service.type == "ClusterIP"
     }
 
     any volume in volumes {
@@ -2658,7 +2658,7 @@ SomeChecker {
     services = [
         {
             type = "ClusterIP"
-            clusterIP = "NONE"
+            clusterIp = "NONE"
         }
     ]
     volumes = [

diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/reference/lang/tour.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/reference/lang/tour.md
@@ -2633,26 +2633,26 @@ rule2 = SomeRule {}
 
 ```python
 # Protocol definition
-protocol Service:
+protocol ServiceProtocol:
     clusterIp: str
     $type: str
 
 # Protocol definition
-protocol Volume:
-    mountPath: [str]
+protocol VolumeProtocol:
+    mountPath: str
 
 # Protocol
 protocol SomeProtocol:
     id: int
     env: {str: any}
-    services: [Service]
-    volumes: [Volume]
+    services: [ServiceProtocol]
+    volumes: [VolumeProtocol]
 
 rule SomeChecker for SomeProtocol:
     id > 0, "id must >0"
 
     all service in services {
-        service.clusterIP == "NONE" if service.type == "ClusterIP"
+        service.clusterIp == "NONE" if service.type == "ClusterIP"
     }
 
     any volume in volumes {
@@ -2668,7 +2668,7 @@ SomeChecker {
     services = [
         {
             type = "ClusterIP"
-            clusterIP = "NONE"
+            clusterIp = "NONE"
         }
     ]
     volumes = [