wip

docs/docs_updated_test.go

@@ -17,7 +17,7 @@ import (
 
 var fixTestsFlag = flag.Bool("fix-tests", false, "update the test files with the current generated content")
 
-func TestCompatibleComponentsSectionsUpdated(t *testing.T) {
+func TestLinksToTypesSectionsUpdated(t *testing.T) {
 	for _, name := range component.AllNames() {
 		t.Run(name, func(t *testing.T) {
 			runForGenerator(t, generator.NewLinksToTypesGenerator(name))
@@ -40,6 +40,13 @@ func TestCompatibleComponentsPageUpdated(t *testing.T) {
 }
 
 func runForGenerator(t *testing.T, g generator.DocsGenerator) {
+	if *fixTestsFlag {
+		err := g.Write()
+		require.NoError(t, err, "failed to write generated content for: %q", g.Name())
+		t.Log("updated the docs with generated content", g.Name())
+		return
+	}
+
 	generated, err := g.Generate()
 	require.NoError(t, err, "failed to generate: %q", g.Name())
 
@@ -51,12 +58,6 @@ func runForGenerator(t *testing.T, g generator.DocsGenerator) {
 		return
 	}
 
-	if *fixTestsFlag && generated != "" {
-		err = g.Write()
-		require.NoError(t, err, "failed to write generated content for: %q", g.Name())
-		t.Log("updated the docs with generated content", g.Name())
-	}
-
 	actual, err := g.Read()
 	require.NoError(t, err, "failed to read existing generated docs for %q, try running 'go generate ./docs'", g.Name())
 	require.Contains(

docs/generator/compatible_components_page.go

@@ -74,9 +74,22 @@ func listOfComponentsExporting(dataType metadata.Type) string {
 }
 
 func listOfLinksToComponents(components []string) string {
+	groups := make(map[string][]string)
+
 	str := ""
-	for _, comp := range components {
-		str += fmt.Sprintf("  - [`%[1]s`]({{< relref \"../components/%[1]s.md\" >}})\n", comp)
+
+	for _, component := range components {
+		parts := strings.SplitN(component, ".", 2)
+		namespace := parts[0]
+		groups[namespace] = append(groups[namespace], component)
+	}
+
+	for namespace, components := range groups {
+		str += fmt.Sprintf("\n{{< collapse title=%q >}}\n", namespace)
+		for _, component := range components {
+			str += fmt.Sprintf("- [`%[1]s`]({{< relref \"../components/%[1]s.md\" >}})\n", component)
+		}
+		str += fmt.Sprintf("{{< /collapse >}}\n")
 	}
 	return str
 }

docs/sources/flow/reference/components/discovery.azure.md

@@ -160,4 +160,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.consul.md

@@ -178,4 +178,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.consulagent.md

@@ -140,4 +140,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.digitalocean.md

@@ -131,4 +131,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.dns.md

@@ -105,4 +105,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.docker.md

@@ -226,4 +226,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.dockerswarm.md

@@ -249,4 +249,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.ec2.md

@@ -145,4 +145,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.eureka.md

@@ -151,4 +151,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.file.md

@@ -184,4 +184,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.gce.md

@@ -124,4 +124,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.hetzner.md

@@ -187,4 +187,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.http.md

@@ -179,4 +179,5 @@ discovery.http "dynamic_targets" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.ionos.md

@@ -151,4 +151,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.kubelet.md

@@ -204,4 +204,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.kubernetes.md

@@ -504,4 +504,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.kuma.md

@@ -146,4 +146,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.lightsail.md

@@ -110,4 +110,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.linode.md

@@ -186,4 +186,5 @@ prometheus.remote_write "demo" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.marathon.md

@@ -156,4 +156,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.nerve.md

@@ -108,4 +108,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.nomad.md

@@ -157,4 +157,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.openstack.md

@@ -168,4 +168,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.puppetdb.md

@@ -167,4 +167,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.relabel.md

@@ -137,4 +137,5 @@ discovery.relabel "keep_backend_only" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.scaleway.md

@@ -185,4 +185,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.serverset.md

@@ -106,4 +106,5 @@ prometheus.remote_write "default" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.triton.md

@@ -140,4 +140,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/discovery.uyuni.md

@@ -134,4 +134,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/faro.receiver.md

@@ -279,4 +279,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/local.file.md

@@ -82,3 +82,6 @@ local.file "secret_key" {
   is_secret = true
 }
 ```
+<!-- START GENERATED COMPATIBLE COMPONENTS -->
+
+<!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/local.file_match.md

@@ -160,4 +160,5 @@ Replace the following:
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.echo.md

@@ -78,4 +78,5 @@ loki.echo "example" { }
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.process.md

@@ -1708,4 +1708,5 @@ loki.process "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.relabel.md

@@ -126,4 +126,5 @@ loki.relabel "keep_error_only" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.api.md

@@ -128,4 +128,5 @@ loki.source.api "loki_push_api" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.awsfirehose.md

@@ -207,4 +207,5 @@ loki.relabel "logging_origin" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.azure_event_hubs.md

@@ -145,4 +145,5 @@ loki.write "example" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.cloudflare.md

@@ -220,4 +220,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.docker.md

@@ -166,4 +166,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.file.md

@@ -247,4 +247,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.gcplog.md

@@ -204,4 +204,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.gelf.md

@@ -100,4 +100,5 @@ loki.write "endpoint" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.heroku.md

@@ -155,4 +155,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.journal.md

@@ -112,4 +112,5 @@ loki.write "endpoint" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.kafka.md

@@ -185,4 +185,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.kubernetes.md

@@ -212,4 +212,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.kubernetes_events.md

@@ -182,4 +182,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.podlogs.md

@@ -301,4 +301,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.syslog.md

@@ -164,4 +164,5 @@ loki.write "local" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.source.windowsevent.md

@@ -86,4 +86,5 @@ loki.write "endpoint" {
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/loki.write.md

@@ -244,4 +244,5 @@ Any labels that start with `__` will be removed before sending to the endpoint.
 
 Note that connecting some components may not be feasible or components may require further configuration to make the connection work correctly. Please refer to the linked documentation for more details.
 
+
 <!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/mimir.rules.kubernetes.md

@@ -267,3 +267,6 @@ roleRef:
   name: grafana-agent
   apiGroup: rbac.authorization.k8s.io
 ```
+<!-- START GENERATED COMPATIBLE COMPONENTS -->
+
+<!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/module.file.md

@@ -163,3 +163,6 @@ prometheus.remote_write "grafana_cloud" {
   }
 }
 ```
+<!-- START GENERATED COMPATIBLE COMPONENTS -->
+
+<!-- END GENERATED COMPATIBLE COMPONENTS -->

docs/sources/flow/reference/components/module.git.md

@@ -215,3 +215,6 @@ module.git "add" {
   }
 }
 ```
+<!-- START GENERATED COMPATIBLE COMPONENTS -->
+
+<!-- END GENERATED COMPATIBLE COMPONENTS -->