chore: update extractors descriptions (#467)

ravisuhag · web-flow · commit 700d08fc30b1 · 2023-01-31T13:05:04.000-06:00
* chore: fix extractor descriptions

* chore: fix console base plugin
diff --git a/plugins/extractors/application_yaml/application_yaml.go b/plugins/extractors/application_yaml/application_yaml.go
@@ -56,7 +56,7 @@ var info = plugins.Info{
 	Description:  "Application metadata from YAML file",
 	SampleConfig: sampleConfig,
 	Summary:      summary,
-	Tags:         []string{"application", "file", "extractor"},
+	Tags:         []string{"application", "file"},
 }
 
 // Extractor is the extractor instance for application YAML file.
diff --git a/plugins/extractors/bigquery/bigquery.go b/plugins/extractors/bigquery/bigquery.go
@@ -1,7 +1,6 @@
 package bigquery
 
 import (
-	"cloud.google.com/go/datacatalog/apiv1/datacatalogpb"
 	"context"
 	_ "embed" // used to print the embedded assets
 	"encoding/base64"
@@ -11,6 +10,8 @@ import (
 	"strings"
 	"sync"
 
+	"cloud.google.com/go/datacatalog/apiv1/datacatalogpb"
+
 	"cloud.google.com/go/bigquery"
 	datacatalog "cloud.google.com/go/datacatalog/apiv1"
 	"github.com/odpf/meteor/models"
@@ -90,7 +91,7 @@ usage_period_in_day: 7`
 var info = plugins.Info{
 	Description:  "Big Query table metadata and metrics",
 	SampleConfig: sampleConfig,
-	Tags:         []string{"gcp", "table", "extractor"},
+	Tags:         []string{"gcp", "table"},
 	Summary:      summary,
 }
 
diff --git a/plugins/extractors/bigtable/bigtable.go b/plugins/extractors/bigtable/bigtable.go
@@ -31,7 +31,7 @@ type Config struct {
 }
 
 var info = plugins.Info{
-	Description: "Compressed, high-performance, proprietary data storage system.",
+	Description: "Compressed, high-performance, data storage system.",
 	Summary:     summary,
 	Tags:        []string{"gcp", "extractor"},
 	SampleConfig: `
diff --git a/plugins/extractors/caramlstore/caramlstore.go b/plugins/extractors/caramlstore/caramlstore.go
@@ -40,7 +40,7 @@ var info = plugins.Info{
 	Description:  "CaraML store ML feature metadata",
 	SampleConfig: sampleConfig,
 	Summary:      summary,
-	Tags:         []string{"caraml", "caramlstore", "ml", "feature", "extractor"},
+	Tags:         []string{"caraml", "ml", "feature"},
 }
 
 // Extractor manages the communication with the CaraML Store service
diff --git a/plugins/extractors/gcs/gcs.go b/plugins/extractors/gcs/gcs.go
@@ -47,7 +47,7 @@ service_account_json: |-
   }`
 
 var info = plugins.Info{
-	Description:  "Online file storage web service for storing and accessing data.",
+	Description:  "Online file storage service By Google",
 	SampleConfig: sampleConfig,
 	Summary:      summary,
 	Tags:         []string{"gcp", "extractor"},
diff --git a/plugins/extractors/http/http_extractor.go b/plugins/extractors/http/http_extractor.go
@@ -74,7 +74,7 @@ var sampleConfig = heredoc.Doc(`
 `)
 
 var info = plugins.Info{
-	Description:  "Generic Extractor capable of using the HTTP response from an external API for constructing 0 or more assets",
+	Description:  "Assets metadata from an external HTTP API",
 	SampleConfig: sampleConfig,
 	Summary:      summary,
 	Tags:         []string{"http", "extractor"},
diff --git a/plugins/extractors/merlin/merlin.go b/plugins/extractors/merlin/merlin.go
@@ -49,7 +49,7 @@ var info = plugins.Info{
 	Description:  "Merlin ML models metadata",
 	SampleConfig: sampleConfig,
 	Summary:      summary,
-	Tags:         []string{"merlin", "ml", "model", "extractor"},
+	Tags:         []string{"merlin", "ml", "model"},
 }
 
 // Extractor manages the communication with the Merlin service.
diff --git a/plugins/extractors/optimus/optimus.go b/plugins/extractors/optimus/optimus.go
@@ -32,7 +32,7 @@ var info = plugins.Info{
 	Description:  "Optimus' jobs metadata",
 	SampleConfig: sampleConfig,
 	Summary:      summary,
-	Tags:         []string{"optimus", "bigquery", "job", "extractor"},
+	Tags:         []string{"optimus", "bigquery"},
 }
 
 // Extractor manages the communication with the bigquery service
diff --git a/plugins/processors/script/tengo_script.go b/plugins/processors/script/tengo_script.go
@@ -49,7 +49,7 @@ var sampleConfig = heredoc.Doc(`
 `)
 
 var info = plugins.Info{
-	Description:  "Transform the extracted asset with the configured Tengo script",
+	Description:  "Transform the asset with a Tengo script",
 	SampleConfig: sampleConfig,
 	Summary:      summary,
 	Tags:         []string{"processor", "transform", "script"},
diff --git a/plugins/sinks/console/sink.go b/plugins/sinks/console/sink.go
@@ -17,9 +17,9 @@ var summary string
 
 var info = plugins.Info{
 	Description:  "Log to standard output",
-	SampleConfig: "",
 	Summary:      summary,
 	Tags:         []string{"log", "sink"},
+	SampleConfig: "",
 }
 
 type Sink struct {
@@ -67,9 +67,7 @@ func (s *Sink) process(asset *assetsv1beta2.Asset) error {
 
 func init() {
 	if err := registry.Sinks.Register("console", func() plugins.Syncer {
-		return &Sink{
-			logger: plugins.GetLog(),
-		}
+		return New(plugins.GetLog())
 	}); err != nil {
 		panic(err)
 	}
diff --git a/plugins/sinks/file/file.go b/plugins/sinks/file/file.go
@@ -27,7 +27,7 @@ type Config struct {
 }
 
 var info = plugins.Info{
-	Description: "save output to a file",
+	Description: "Save output to a file",
 	Summary:     summary,
 	Tags:        []string{"file", "json", "yaml", "sink"},
 	SampleConfig: heredoc.Doc(`
@@ -53,7 +53,7 @@ func New(logger log.Logger) plugins.Syncer {
 	return s
 }
 
-func (s *Sink) Init(ctx context.Context, config plugins.Config) (error) {
+func (s *Sink) Init(ctx context.Context, config plugins.Config) error {
 	if err := s.BasePlugin.Init(ctx, config); err != nil {
 		return err
 	}
@@ -121,7 +121,7 @@ func (s *Sink) yamlOut(data []*assetsv1beta2.Asset) error {
 	if err != nil {
 		return err
 	}
-	
+
 	return s.writeBytes(ymlByte)
 }
 

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ var info = plugins.Info{`
`56`	`56`	`Description: "Application metadata from YAML file",`
`57`	`57`	`SampleConfig: sampleConfig,`
`58`	`58`	`Summary: summary,`
`59`		`- Tags: []string{"application", "file", "extractor"},`
	`59`	`+ Tags: []string{"application", "file"},`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`// Extractor is the extractor instance for application YAML file.`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ type Config struct {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`var info = plugins.Info{`
`34`		`- Description: "Compressed, high-performance, proprietary data storage system.",`
	`34`	`+ Description: "Compressed, high-performance, data storage system.",`
`35`	`35`	`Summary: summary,`
`36`	`36`	`Tags: []string{"gcp", "extractor"},`
`37`	`37`	SampleConfig: `
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ var info = plugins.Info{`
`40`	`40`	`Description: "CaraML store ML feature metadata",`
`41`	`41`	`SampleConfig: sampleConfig,`
`42`	`42`	`Summary: summary,`
`43`		`- Tags: []string{"caraml", "caramlstore", "ml", "feature", "extractor"},`
	`43`	`+ Tags: []string{"caraml", "ml", "feature"},`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`// Extractor manages the communication with the CaraML Store service`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ var info = plugins.Info{`
`49`	`49`	`Description: "Merlin ML models metadata",`
`50`	`50`	`SampleConfig: sampleConfig,`
`51`	`51`	`Summary: summary,`
`52`		`- Tags: []string{"merlin", "ml", "model", "extractor"},`
	`52`	`+ Tags: []string{"merlin", "ml", "model"},`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`// Extractor manages the communication with the Merlin service.`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ var info = plugins.Info{`
`32`	`32`	`Description: "Optimus' jobs metadata",`
`33`	`33`	`SampleConfig: sampleConfig,`
`34`	`34`	`Summary: summary,`
`35`		`- Tags: []string{"optimus", "bigquery", "job", "extractor"},`
	`35`	`+ Tags: []string{"optimus", "bigquery"},`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`// Extractor manages the communication with the bigquery service`