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.

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

[Doc] Format options to Improve readability #84

Merged
merged 2 commits into from
Apr 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
## 3.0.11
- [DOC] Fixed formatting to improve readability [#84](https://github.com/logstash-plugins/logstash-filter-csv/pull/84)

## 3.0.10
- Fix asciidoc formatting for example [#73](https://github.com/logstash-plugins/logstash-filter-csv/pull/73)
- [DOC] Fix asciidoc formatting for example [#73](https://github.com/logstash-plugins/logstash-filter-csv/pull/73)

## 3.0.9
- Document that the `autodetect_column_names` and `skip_header` options work only when the number of Logstash
- [DOC] Document that the `autodetect_column_names` and `skip_header` options work only when the number of Logstash
pipeline workers is set to `1`.

## 3.0.8
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.0.10
3.0.11
8 changes: 4 additions & 4 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -153,10 +153,10 @@ This tag can referenced by users if they wish to cancel events using an 'if' con
Define whether the header should be skipped.
Defaults to false. If set to true, the header will be skipped.
Assumes that header is not repeated within further rows as such rows will also be skipped.
If skip_header is set without autodetect_column_names being set then columns should be set which
If `skip_header` is set without `autodetect_column_names` being set then columns should be set which
will result in the skipping of any row that exactly matches the specified column values.
If skip_header and autodetect_column_names are specified then columns should not be specified, in this case
autodetect_column_names will fill the columns setting in the background, from the first event seen, and any
If `skip_header` and `autodetect_column_names` are specified then columns should not be specified, in this case
`autodetect_column_names` will fill the columns setting in the background, from the first event seen, and any
subsequent values that match what was autodetected will be skipped.

Logstash pipeline workers must be set to `1` for this option to work.
Expand All @@ -182,4 +182,4 @@ Defaults to writing to the root of the event.


[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]
include::{include_path}/{type}.asciidoc[]