Skip to content

Commit 859fe61

Browse files
authored
docs(sinks): Remove partitioning docs (#15723)
They were incorrectly showing up on all request-based sinks even though not all support dynamic partitioning. Instead I just added additional pointers to the template docs with the options that support templating. Closes: #11242 Signed-off-by: Jesse Szwedko <[email protected]> Signed-off-by: Jesse Szwedko <[email protected]>
1 parent a29c5fb commit 859fe61

File tree

2 files changed

+12
-22
lines changed

2 files changed

+12
-22
lines changed

website/cue/reference/components/sinks.cue

-22
Original file line numberDiff line numberDiff line change
@@ -568,28 +568,6 @@ components: sinks: [Name=string]: {
568568
}
569569
}
570570

571-
if features.send != _|_ {
572-
if features.send.request.enabled {
573-
partitioning: _ | *{
574-
title: "Partitioning"
575-
body: """
576-
Vector supports dynamic configuration values through a simple
577-
template syntax. If an option supports templating, it will be
578-
noted with a badge and you can use event fields to create dynamic
579-
values. For example:
580-
581-
```toml title="vector.toml"
582-
[sinks.my-sink]
583-
dynamic_option = "application={{ application_id }}"
584-
```
585-
586-
In the above example, the `application_id` for each event will be
587-
used to partition outgoing data.
588-
"""
589-
}
590-
}
591-
}
592-
593571
if features.send != _|_ {
594572
if features.send.request.enabled {
595573
rate_limits: {

website/layouts/partials/data.html

+12
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@
4141
{{ with $v.syntax }}
4242
{{ if eq . "remap_program" }}
4343
{{ partial "badge.html" (dict "word" . "color" "gray" "href" "/docs/reference/vrl#program") }}
44+
{{ else if eq . "template" }}
45+
{{ partial "badge.html" (dict "word" . "color" "gray" "href" "/docs/reference/configuration/template-syntax/") }}
4446
{{ else }}
4547
{{ partial "badge.html" (dict "word" . "color" "gray") }}
4648
{{ end }}
@@ -1961,6 +1963,8 @@ <h3 id="{{ $code }}">
19611963
{{ with $v.syntax }}
19621964
{{ if eq . "remap_program" }}
19631965
{{ partial "badge.html" (dict "word" . "color" "gray" "href" "/docs/reference/vrl#program") }}
1966+
{{ else if eq . "template" }}
1967+
{{ partial "badge.html" (dict "word" . "color" "gray" "href" "/docs/reference/configuration/template-syntax/") }}
19641968
{{ else }}
19651969
{{ partial "badge.html" (dict "word" . "color" "gray") }}
19661970
{{ end }}
@@ -1977,6 +1981,14 @@ <h3 id="{{ $code }}">
19771981
{{ $v.description | markdownify }}
19781982
</div>
19791983

1984+
{{ if eq $v.type.string.syntax "template" }}
1985+
<div class="mt-4 text-sm">
1986+
<strong>Note</strong>: This parameter supports Vector's
1987+
<a href="/docs/reference/configuration/template-syntax">template syntax</a>, which enables you to use
1988+
dynamic per-event values.
1989+
</div>
1990+
{{ end }}
1991+
19801992
{{ with $v.relevant_when }}
19811993
<div class="mt-2">
19821994
<span>

0 commit comments

Comments
 (0)