Skip to content

Commit

Permalink
Add copyright comments to docs templates (redpanda-data#2723)
Browse files Browse the repository at this point in the history
* Add copyright comments to docs templates

* Switch to new copyright format

* Add ai copyright notes
  • Loading branch information
Jeffail authored Jul 24, 2024
1 parent 3658f4f commit 4e3b047
Show file tree
Hide file tree
Showing 255 changed files with 510 additions and 0 deletions.
2 changes: 2 additions & 0 deletions cmd/tools/docs_gen/templates/bloblang_functions.adoc.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ Introduced in version {{.Version}}.
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/bloblang_functions.adoc.tmpl
////

// © 2024 Redpanda Data Inc.


Functions can be placed anywhere and allow you to extract information from your environment, generate values, or access data from the underlying message being mapped:

Expand Down
2 changes: 2 additions & 0 deletions cmd/tools/docs_gen/templates/bloblang_methods.adoc.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Introduced in version {{.Version}}.
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/bloblang_methods.adoc.tmpl
////

// © 2024 Redpanda Data Inc.


Methods provide most of the power in Bloblang as they allow you to augment values and can be added to any expression (including other methods):

Expand Down
2 changes: 2 additions & 0 deletions cmd/tools/docs_gen/templates/http.adoc.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/http.adoc.tmpl
////

// © 2024 Redpanda Data Inc.

When {page-component-title} runs it kicks off an HTTP server that provides a few generally useful endpoints and is also where configured components such as the xref:components:inputs/http_server.adoc[`http_server` input] xref:components:outputs/http_server.adoc[and output] can register their own endpoints if they don't require their own host/port.

The configuration for this server lives under the `http` namespace, with the following default values:
Expand Down
2 changes: 2 additions & 0 deletions cmd/tools/docs_gen/templates/logger.adoc.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/logger.adoc.tmpl
////

// © 2024 Redpanda Data Inc.

{page-component-title} logging prints to stdout (or stderr if your output is stdout) and is formatted as https://brandur.org/logfmt[logfmt^] by default. Use these configuration options to change both the logging formats as well as the destination of logs.

{{if eq .CommonConfigYAML .AdvancedConfigYAML -}}
Expand Down
2 changes: 2 additions & 0 deletions cmd/tools/docs_gen/templates/plugin.adoc.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////

// © 2024 Redpanda Data Inc.


component_type_dropdown::[]

Expand Down
2 changes: 2 additions & 0 deletions cmd/tools/docs_gen/templates/templates.adoc.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
https://github.com/redpanda-data/connect/blob/main/cmd/tools/docs_gen/templates/templates.adoc.tmpl
////

// © 2024 Redpanda Data Inc.

[CAUTION]
====
Templates are an experimental feature and are subject to change outside major version releases.
Expand Down
2 changes: 2 additions & 0 deletions cmd/tools/docs_gen/templates/tests.adoc.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/tests.adoc.tmpl
////

// © 2024 Redpanda Data Inc.

The {page-component-title} service offers a command `rpk connect test` for running unit tests on sections of a configuration file. This makes it easy to protect your config files from regressions over time.

== Writing a test
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/buffers/memory.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/buffers/none.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/buffers/sqlite.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/buffers/system_window.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/aws_dynamodb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/aws_s3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/couchbase.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/file.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/gcp_cloud_storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/lru.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/memcached.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/memory.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/mongodb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/multilevel.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/nats_kv.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/noop.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/redis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/ristretto.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/sql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/caches/ttlru.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/http/about.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/http.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
When {page-component-title} runs it kicks off an HTTP server that provides a few generally useful endpoints and is also where configured components such as the xref:components:inputs/http_server.adoc[`http_server` input] xref:components:outputs/http_server.adoc[and output] can register their own endpoints if they don't require their own host/port.
The configuration for this server lives under the `http` namespace, with the following default values:
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/amqp_0_9.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/amqp_1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/aws_kinesis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/aws_s3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/aws_sqs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/azure_blob_storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/azure_cosmosdb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/azure_queue_storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/azure_table_storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/batched.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/beanstalkd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/broker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/cassandra.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/csv.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/components/pages/inputs/discord.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl
////
// © 2024 Redpanda Data Inc.
component_type_dropdown::[]
Expand Down
Loading

0 comments on commit 4e3b047

Please sign in to comment.