Skip to content

Commit 85dd439

Browse files
authored
chore(docs): make YAML appear first in the example configurations (vectordotdev#18325)
1 parent 61c0ae8 commit 85dd439

File tree

9 files changed

+24
-24
lines changed

9 files changed

+24
-24
lines changed

website/content/en/docs/about/under-the-hood/architecture/pipeline-model.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Vector's pipeline model is based on a [directed acyclic graph][dag] of [componen
1010

1111
## Defining pipelines
1212

13-
A Vector pipeline is defined through a TOML, YAML, or JSON [configuration] file. For maintainability, many Vector users use configuration and data templating languages like [Jsonnet] or [CUE].
13+
A Vector pipeline is defined through a YAML, TOML, or JSON [configuration] file. For maintainability, many Vector users use configuration and data templating languages like [Jsonnet] or [CUE].
1414

1515
Configuration is checked at pipeline compile time (when Vector boots). This prevents simple mistakes and enforces DAG properties.
1616

website/content/en/docs/reference/configuration/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ environment variable example.
270270

271271
### Formats
272272

273-
Vector supports [TOML], [YAML], and [JSON] to ensure that Vector fits into your
273+
Vector supports [YAML], [TOML], and [JSON] to ensure that Vector fits into your
274274
workflow. A side benefit of supporting YAML and JSON is that they enable you to use
275275
data templating languages such as [ytt], [Jsonnet] and [Cue].
276276

website/cue/reference.cue

+1-1
Original file line numberDiff line numberDiff line change
@@ -455,8 +455,8 @@ _values: {
455455
456456
Config format | Example
457457
:-------------|:-------
458-
[TOML](\(urls.toml)) | `condition = ".status == 200"`
459458
[YAML](\(urls.yaml)) | `condition: .status == 200`
459+
[TOML](\(urls.toml)) | `condition = ".status == 200"`
460460
[JSON](\(urls.json)) | `"condition": ".status == 200"`
461461
"""
462462
}

website/cue/reference/administration/management.cue

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ administration: management: {
1616
variables: {
1717
variants?: [string, ...string]
1818

19-
config_formats: ["toml", "yaml", "json"]
19+
config_formats: ["yaml", "toml", "json"]
2020
}
2121

2222
manage?: {

website/cue/reference/cli.cue

+14-14
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,11 @@ cli: {
136136
type: "string"
137137
env_var: "VECTOR_CONFIG_DIR"
138138
}
139+
"config-yaml": {
140+
description: env_vars.VECTOR_CONFIG_YAML.description
141+
type: "string"
142+
env_var: "VECTOR_CONFIG_YAML"
143+
}
139144
"config-toml": {
140145
description: env_vars.VECTOR_CONFIG_TOML.description
141146
type: "string"
@@ -146,11 +151,6 @@ cli: {
146151
type: "string"
147152
env_var: "VECTOR_CONFIG_JSON"
148153
}
149-
"config-yaml": {
150-
description: env_vars.VECTOR_CONFIG_YAML.description
151-
type: "string"
152-
env_var: "VECTOR_CONFIG_YAML"
153-
}
154154
"graceful-shutdown-limit-secs": {
155155
description: env_vars.VECTOR_GRACEFUL_SHUTDOWN_LIMIT_SECS.description
156156
default: env_vars.VECTOR_GRACEFUL_SHUTDOWN_LIMIT_SECS.type.uint.default
@@ -200,7 +200,7 @@ cli: {
200200
You can also visualize the output online at [webgraphviz.com](http://www.webgraphviz.com/).
201201
"""
202202

203-
example: "vector graph --config /etc/vector/vector.toml | dot -Tsvg > graph.svg"
203+
example: "vector graph --config /etc/vector/vector.yaml | dot -Tsvg > graph.svg"
204204

205205
options: _core_options
206206
}
@@ -333,8 +333,8 @@ cli: {
333333
type: "enum"
334334
default: "json"
335335
enum: {
336-
json: "Output events as JSON"
337336
yaml: "Output events as YAML"
337+
json: "Output events as JSON"
338338
logfmt: "Output events as logfmt"
339339
}
340340
}
@@ -416,24 +416,24 @@ cli: {
416416
}
417417

418418
options: {
419-
"config-toml": {
419+
"config-yaml": {
420420
description: """
421421
Any number of Vector config files to validate.
422-
TOML file format is assumed.
422+
YAML file format is assumed.
423423
"""
424424
type: "string"
425425
}
426-
"config-json": {
426+
"config-toml": {
427427
description: """
428428
Any number of Vector config files to validate.
429-
JSON file format is assumed.
429+
TOML file format is assumed.
430430
"""
431431
type: "string"
432432
}
433-
"config-yaml": {
433+
"config-json": {
434434
description: """
435435
Any number of Vector config files to validate.
436-
YAML file format is assumed.
436+
JSON file format is assumed.
437437
"""
438438
type: "string"
439439
}
@@ -537,7 +537,7 @@ cli: {
537537
Read configuration from one or more files. Wildcard paths are supported. If no files are
538538
specified the default config path `/etc/vector/vector.toml` is targeted. TOML, YAML and
539539
JSON file formats are supported. The format to interpret the file with is determined from
540-
the file extension (`.toml`, `.yaml`, `.json`). Vector falls back to TOML if it can't
540+
the file extension (`.yaml`, `.toml`, `.json`). Vector falls back to YAML if it can't
541541
detect a supported format.
542542
"""
543543
type: string: {

website/cue/reference/configuration.cue

+1-1
Original file line numberDiff line numberDiff line change
@@ -701,7 +701,7 @@ configuration: {
701701
formats: {
702702
title: "Formats"
703703
body: """
704-
Vector supports [TOML](\(urls.toml)), [YAML](\(urls.yaml)), and [JSON](\(urls.json)) to
704+
Vector supports [YAML](\(urls.yaml)), [TOML](\(urls.toml)), and [JSON](\(urls.json)) to
705705
ensure Vector fits into your workflow. A side benefit of supporting YAML and JSON is that they
706706
enable you to use data templating languages such as [ytt](\(urls.ytt)), [Jsonnet](\(urls.jsonnet)) and
707707
[Cue](\(urls.cue)).

website/layouts/partials/blog/authors.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@
1919
</a>
2020
{{ end }}
2121
</div>
22-
</div>
22+
</div>

website/layouts/partials/components/example-configs.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{{ $examples := .examples }}
22
{{ $levels := slice "common" "advanced" }}
3-
{{ $formats := slice "toml" "yaml" "json" }}
3+
{{ $formats := slice "yaml" "toml" "json" }}
44
<div x-data="{ level: 'common', format: $store.global.format }" class="no-prose mb-4 border dark:border-gray-700 rounded-md shadow py-4 px-6">
55
<span>
66
{{ partial "heading.html" (dict "text" "Example configurations" "level" 3) }}
@@ -34,4 +34,4 @@
3434
{{ end }}
3535
</div>
3636
{{ end }}
37-
</div>
37+
</div>

website/layouts/partials/data.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@
318318

319319
{{/* Source/transform/sink examples */}}
320320
{{ with .component_examples }}
321-
{{ $formats := slice "toml" "yaml" "json" }}
321+
{{ $formats := slice "yaml" "toml" "json" }}
322322
{{ $defaultFormat := index $formats 0 }}
323323
<div class="no-prose flex flex-col divide-y dark:divide-gray-700">
324324
{{ range . }}
@@ -2193,7 +2193,7 @@ <h3 id="{{ $code }}">
21932193
{{ partial "heading.html" (dict "text" .title "level" 4) }}
21942194
</span>
21952195

2196-
{{ $formats := slice "toml" "yaml" "json" }}
2196+
{{ $formats := slice "yaml" "toml" "json" }}
21972197
<div class="flex space-x-2">
21982198
{{ range $formats }}
21992199
<button @click="$store.global.setFormat('{{ . }}')"

0 commit comments

Comments
 (0)