review(@pepov): Applying new doc format

Signed-off-by: Csaba Tűz <[email protected]>
kube-logging · Nov 28, 2023 · 8d311c8 · 8d311c8
1 parent 42dc258
commit 8d311c8
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 70 deletions.
diff --git a/docs/configuration/plugins/filters/useragent.md b/docs/configuration/plugins/filters/useragent.md
@@ -37,40 +37,39 @@ Join hashed data by '_'
 Default: false
 
 
- ## Example `UserAgent` filter configurations
- ```yaml
- apiVersion: logging.banzaicloud.io/v1beta1
- kind: Flow
- metadata:
-
-	name: demo-flow
-
- spec:
-
-	filters:
-	  - useragent:
-	      key_name: my_agent
-	      delete_key: true
-	      out_key: ua_fields
-	      flatten: true
-	selectors: {}
-	localOutputRefs:
-	  - demo-output
-
- ```
-
- #### Fluentd Config Result
- ```yaml
- <filter **>
-
-	@type ua_parser
-	@id test_useragent
-	key_name my_agent
-	delete_key true
-	out_key ua_fields
-	flatten true
-
- </filter>
- ```
+
+## Example `UserAgent` filter configurations
+```yaml
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Flow
+metadata:
+
+  name: demo-flow
+
+spec:
+  filters:
+    - useragent:
+        key_name: my_agent
+        delete_key: true
+        out_key: ua_fields
+        flatten: true
+  selectors: {}
+  localOutputRefs:
+    - demo-output
+```
+
+
+## Fluentd Config Result
+```xml
+<filter **>
+  @type ua_parser
+  @id test_useragent
+  key_name my_agent
+  delete_key true
+  out_key ua_fields
+  flatten true
+</filter>
+```
+
 
 ---
diff --git a/pkg/sdk/logging/model/filter/useragent.go b/pkg/sdk/logging/model/filter/useragent.go
@@ -47,41 +47,41 @@ type UserAgent struct {
 	Flatten bool `json:"flatten,omitempty"`
 }
 
-// ## Example `UserAgent` filter configurations
-// ```yaml
-// apiVersion: logging.banzaicloud.io/v1beta1
-// kind: Flow
-// metadata:
-//
-//	name: demo-flow
-//
-// spec:
-//
-//	filters:
-//	  - useragent:
-//	      key_name: my_agent
-//	      delete_key: true
-//	      out_key: ua_fields
-//	      flatten: true
-//	selectors: {}
-//	localOutputRefs:
-//	  - demo-output
-//
-// ```
-//
-// #### Fluentd Config Result
-// ```yaml
-// <filter **>
-//
-//	@type ua_parser
-//	@id test_useragent
-//	key_name my_agent
-//	delete_key true
-//	out_key ua_fields
-//	flatten true
-//
-// </filter>
-// ```
+/*
+## Example `UserAgent` filter configurations
+```yaml
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Flow
+metadata:
+
+  name: demo-flow
+
+spec:
+  filters:
+    - useragent:
+        key_name: my_agent
+        delete_key: true
+        out_key: ua_fields
+        flatten: true
+  selectors: {}
+  localOutputRefs:
+    - demo-output
+```
+*/
+// +docName:"Fluentd Config Result"
+/*
+## Fluentd Config Result
+```xml
+<filter **>
+  @type ua_parser
+  @id test_useragent
+  key_name my_agent
+  delete_key true
+  out_key ua_fields
+  flatten true
+</filter>
+```
+*/
 type _expUserAgent interface{} //nolint:deadcode,unused
 
 func (g *UserAgent) ToDirective(secretLoader secret.SecretLoader, id string) (types.Directive, error) {