Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): improve source data_dir docs #19596

Merged
merged 3 commits into from
Jan 12, 2024
Merged

chore(docs): improve source data_dir docs #19596

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8609641
chore(docs): improve source data_dir docs
pront Jan 11, 2024
e3fdf66
fix doc content
pront Jan 12, 2024
38f24c7
regen docs
pront Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/sources/file.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,10 @@ pub struct FileConfig {

/// The directory used to persist file checkpoint positions.
///
/// By default, the [global `data_dir` option][global_data_dir] is used. Make sure the running user has write
/// permissions to this directory.
/// By default, the [global `data_dir` option][global_data_dir] is used.
/// Make sure the running user has write permissions to this directory.
///
/// If this directory is specified, then Vector will attempt to create it.
///
/// [global_data_dir]: https://vector.dev/docs/reference/configuration/global-options/#data_dir
#[serde(default)]
Expand Down
8 changes: 6 additions & 2 deletions src/sources/journald.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,12 @@ pub struct JournaldConfig {

/// The directory used to persist file checkpoint positions.
///
/// By default, the global `data_dir` option is used. Make sure the running user has write
/// permissions to this directory.
/// By default, the [global `data_dir` option][global_data_dir] is used.
/// Make sure the running user has write permissions to this directory.
///
/// If this directory is specified, then Vector will attempt to create it.
///
/// [global_data_dir]: https://vector.dev/docs/reference/configuration/global-options/#data_dir
#[serde(default)]
#[configurable(metadata(docs::examples = "/var/lib/vector"))]
#[configurable(metadata(docs::human_name = "Data Directory"))]
Expand Down
8 changes: 6 additions & 2 deletions src/sources/kubernetes_logs/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,12 @@ pub struct Config {

/// The directory used to persist file checkpoint positions.
///
/// By default, the global `data_dir` option is used. Make sure the running user has write
/// permissions to this directory.
/// By default, the [global `data_dir` option][global_data_dir] is used.
/// Make sure the running user has write permissions to this directory.
///
/// If this directory is specified, then Vector will attempt to create it.
///
/// [global_data_dir]: https://vector.dev/docs/reference/configuration/global-options/#data_dir
#[configurable(metadata(docs::examples = "/var/local/lib/vector/"))]
#[configurable(metadata(docs::human_name = "Data Directory"))]
data_dir: Option<PathBuf>,
Expand Down
6 changes: 4 additions & 2 deletions website/cue/reference/components/sources/base/file.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ base: components: sources: file: configuration: {
description: """
The directory used to persist file checkpoint positions.

By default, the [global `data_dir` option][global_data_dir] is used. Make sure the running user has write
permissions to this directory.
By default, the [global `data_dir` option][global_data_dir] is used.
Make sure the running user has write permissions to this directory.

If this directory is specified, then it will be created under the [global `data_dir`][global_data_dir].

[global_data_dir]: https://vector.dev/docs/reference/configuration/global-options/#data_dir
"""
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sources/base/journald.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,12 @@ base: components: sources: journald: configuration: {
description: """
The directory used to persist file checkpoint positions.

By default, the global `data_dir` option is used. Make sure the running user has write
permissions to this directory.
By default, the [global `data_dir` option][global_data_dir] is used.
Make sure the running user has write permissions to this directory.

If this directory is specified, then it will be created under the [global `data_dir`][global_data_dir].

[global_data_dir]: https://vector.dev/docs/reference/configuration/global-options/#data_dir
"""
required: false
type: string: examples: ["/var/lib/vector"]
Expand Down
8 changes: 6 additions & 2 deletions website/cue/reference/components/sources/base/kubernetes_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,12 @@ base: components: sources: kubernetes_logs: configuration: {
description: """
The directory used to persist file checkpoint positions.

By default, the global `data_dir` option is used. Make sure the running user has write
permissions to this directory.
By default, the [global `data_dir` option][global_data_dir] is used.
Make sure the running user has write permissions to this directory.

If this directory is specified, then it will be created under the [global `data_dir`][global_data_dir].

[global_data_dir]: https://vector.dev/docs/reference/configuration/global-options/#data_dir
"""
required: false
type: string: examples: ["/var/local/lib/vector/"]
Expand Down
Loading