feat: expose description field in Operator entity (#66)

Because - Component page includes a short description of the component. This commit - Updates `protogen-go` to use the new `description` field in the operator entity in `protobufs`. - Modifies the `description` fields in the operator definitions to use the imperative form.
instill-ai · Mar 4, 2024 · 043d5e3 · 043d5e3
1 parent 9068146
commit 043d5e3
Show file tree

Hide file tree

Showing 11 changed files with 15 additions and 15 deletions.
diff --git a/go.mod b/go.mod
@@ -7,7 +7,7 @@ require (
 	github.com/fogleman/gg v1.3.0
 	github.com/frankban/quicktest v1.14.6
 	github.com/gofrs/uuid v4.4.0+incompatible
-	github.com/instill-ai/component v0.12.0-beta
+	github.com/instill-ai/component v0.12.0-beta.0.20240304105959-85bbc223c1df
 	github.com/instill-ai/x v0.4.0-alpha
 	github.com/itchyny/gojq v0.12.14
 	github.com/pkoukk/tiktoken-go v0.1.6
@@ -35,7 +35,7 @@ require (
 	github.com/google/go-cmp v0.5.9 // indirect
 	github.com/google/uuid v1.3.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.7.2 // indirect
-	github.com/instill-ai/protogen-go v0.3.3-alpha.0.20240226101151-03ed57d8f5f7 // indirect
+	github.com/instill-ai/protogen-go v0.3.3-alpha.0.20240304063945-0080cc53de5e // indirect
 	github.com/itchyny/timefmt-go v0.1.5 // indirect
 	github.com/jaytaylor/html2text v0.0.0-20230321000545-74c2419ad056 // indirect
 	github.com/kr/pretty v0.3.1 // indirect

diff --git a/go.sum b/go.sum
@@ -51,10 +51,10 @@ github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/grpc-ecosystem/grpc-gateway/v2 v2.7.2 h1:I/pwhnUln5wbMnTyRbzswA0/JxpK8sZj0aUfI3TV1So=
 github.com/grpc-ecosystem/grpc-gateway/v2 v2.7.2/go.mod h1:lsuH8kb4GlMdSlI4alNIBBSAt5CHJtg3i+0WuN9J5YM=
-github.com/instill-ai/component v0.12.0-beta h1:v2jJ9xI3m+MDd322c5Zoock9Nwj7mb+aKGKeNwDS8s8=
-github.com/instill-ai/component v0.12.0-beta/go.mod h1:Du5OtjOpKWfhUd0IXdsp5bu0FcRXv1gh8pkzMi4UXQ0=
-github.com/instill-ai/protogen-go v0.3.3-alpha.0.20240226101151-03ed57d8f5f7 h1:h8u5tmkmoHaJy6CpRNZtFLac5x6AGa9PWt2cfK7kH2Y=
-github.com/instill-ai/protogen-go v0.3.3-alpha.0.20240226101151-03ed57d8f5f7/go.mod h1:jhEL0SauySMoPLVvx105DWyThju9sYTbsXIySVCArmM=
+github.com/instill-ai/component v0.12.0-beta.0.20240304105959-85bbc223c1df h1:T8xczmtdyZXrHW7mVwNXTi/WaBYgPw8wUE1Pm+ptkuc=
+github.com/instill-ai/component v0.12.0-beta.0.20240304105959-85bbc223c1df/go.mod h1:mvySqiBVNAy5wpDZnPdUZ/P1Iaj2BZJmi328hRMS818=
+github.com/instill-ai/protogen-go v0.3.3-alpha.0.20240304063945-0080cc53de5e h1:fHbGDWVbaFFSrqRmy5cKDlBT/8nlsfS5m5LIo3P7Q70=
+github.com/instill-ai/protogen-go v0.3.3-alpha.0.20240304063945-0080cc53de5e/go.mod h1:jhEL0SauySMoPLVvx105DWyThju9sYTbsXIySVCArmM=
 github.com/instill-ai/x v0.4.0-alpha h1:zQV2VLbSHjMv6gyBN/2mwwrvWk0/mJM6ZKS12AzjfQg=
 github.com/instill-ai/x v0.4.0-alpha/go.mod h1:L6jmDPrUou6XskaLXZuK/gDeitdoPa9yE8ONKt1ZwCw=
 github.com/itchyny/gojq v0.12.14 h1:6k8vVtsrhQSYgSGg827AD+PVVaB1NLXEdX+dda2oZCc=

diff --git a/pkg/base64/v0/README.mdx b/pkg/base64/v0/README.mdx
@@ -5,7 +5,7 @@ draft: false
 description: "Learn about how to set up a VDP Base64 operator https://github.com/instill-ai/vdp"
 ---
 
-The Base64 component is an operator that enables users to encode or decode a string in Base64 format.
+The Base64 component is an operator that allows users to encode or decode a string in Base64 format.
 It can carry out the following tasks:
 
 - [Encode](#encode)

diff --git a/pkg/base64/v0/config/definitions.json b/pkg/base64/v0/config/definitions.json
@@ -16,6 +16,6 @@
     "uid": "3a836447-c211-4134-9cc5-ad45e1cc467e",
     "version": "0.1.0-alpha",
     "source_url": "https://github.com/instill-ai/operator/blob/main/pkg/base64/v0",
-    "description": "Enables users to encode or decode a string in Base64 format"
+    "description": "Encode or decode a string in Base64 format"
   }
 ]
diff --git a/pkg/end/v0/config/definitions.json b/pkg/end/v0/config/definitions.json
@@ -15,6 +15,6 @@
     "uid": "4f39c8bc-8617-495d-80de-80d0f5397516",
     "version": "0.1.0-alpha",
     "source_url": "https://github.com/instill-ai/operator/blob/main/pkg/end/v0",
-    "description": "Serves as the output interface of a pipeline when triggered synchronously"
+    "description": "Create an output interface in a pipeline when triggered synchronously"
   }
 ]
diff --git a/pkg/image/v0/config/definitions.json b/pkg/image/v0/config/definitions.json
@@ -19,6 +19,6 @@
     "uid": "e9eb8fc8-f249-4e11-ad50-5035d79ffc18",
     "version": "0.1.0-alpha",
     "source_url": "https://github.com/instill-ai/operator/blob/main/pkg/image/v0",
-    "description": "Manipulates image files"
+    "description": "Manipulate image files"
   }
 ]
diff --git a/pkg/json/v0/README.mdx b/pkg/json/v0/README.mdx
@@ -5,7 +5,7 @@ draft: false
 description: "Learn about how to set up a VDP JSON operator https://github.com/instill-ai/vdp"
 ---
 
-The JSON component is an operator that enables users to manipulate and convert JSON objects.
+The JSON component is an operator that allows users to manipulate and convert JSON objects.
 It can carry out the following tasks:
 
 - [Marshal](#marshal)

diff --git a/pkg/json/v0/config/definitions.json b/pkg/json/v0/config/definitions.json
@@ -16,6 +16,6 @@
     "uid": "28f53d15-6150-46e6-99aa-f76b70a926c0",
     "version": "0.1.0-alpha",
     "source_url": "https://github.com/instill-ai/operator/blob/main/pkg/json/v0",
-    "description": "Enables users to manipulate and convert JSON objects"
+    "description": "Manipulate and convert JSON objects"
   }
 ]
diff --git a/pkg/start/v0/config/definitions.json b/pkg/start/v0/config/definitions.json
@@ -15,6 +15,6 @@
     "uid": "2ac8be70-0f7a-4b61-a33d-098b8acfa6f3",
     "version": "0.1.0-alpha",
     "source_url": "https://github.com/instill-ai/operator/blob/main/pkg/start/v0",
-    "description": "Enables users to define data formats customized for their AI-first applications"
+    "description": "Define data formats customized for their AI-first applications"
   }
 ]
diff --git a/pkg/text/v0/README.mdx b/pkg/text/v0/README.mdx
@@ -5,7 +5,7 @@ draft: false
 description: "Learn about how to set up a VDP Text operator https://github.com/instill-ai/vdp"
 ---
 
-The Text component is an operator that enables users to extract and manipulate text from different sources.
+The Text component is an operator that allows users to extract and manipulate text from different sources.
 It can carry out the following tasks:
 
 - [Convert To Text](#convert-to-text)

diff --git a/pkg/text/v0/config/definitions.json b/pkg/text/v0/config/definitions.json
@@ -15,6 +15,6 @@
     "uid": "5b7aca5b-1ae3-477f-bf60-d34e1c993c87",
     "version": "0.1.0-alpha",
     "source_url": "https://github.com/instill-ai/operator/blob/main/pkg/text/v0",
-    "description": "Enables users to extract and manipulate text from different sources"
+    "description": "Extract and manipulate text from different sources"
   }
 ]