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

[Docs] Watcher clarification on CSV formulas warning. #83088

Merged
merged 3 commits into from
Jan 27, 2022

Conversation

a03nikki
Copy link
Contributor

Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

Existing https://www.elastic.co/guide/en/elasticsearch/reference/master/notification-settings.html#watcher-email-pkcs12-files

PKCS#12 files
...

xpack.notification.reporting.warning.kbn-csv-contains-formulas.text
(Dynamic) Specifies a custom message to be sent if the formula verification criteria for CSV files, from kibana xpack.reporting.csv.checkForFormulas, is true. Use %s in the message as a placeholder for the filename.

Slack Notification Settings
...

Proposed https://www.elastic.co/guide/en/elasticsearch/reference/master/notification-settings.html#email-notification-settings

Email Notification Settings
...

xpack.notification.reporting.warning.kbn-csv-contains-formulas.text
(Dynamic) Specifies a custom message to be sent if the formula verification criteria for CSV files, from Kibana's xpack.reporting.csv.checkForFormulas, is true. Use %s in the message as a placeholder for the filename.
Defaults to Warning: The attachment [%s] contains characters which spreadsheet applications may interpret as formulas. Please ensure that the attachment is safe prior to opening.

Watcher Email TLS/SSL settings
...

The missing space in the default value was already fixed on the master branch but it isn't on 7.16.

…k.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Data Management Meta label for data/management team labels Jan 25, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

@elasticsearchmachine elasticsearchmachine added v8.1.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Jan 25, 2022
Co-authored-by: Adam Locke <adam.locke@elastic.co>
Copy link
Contributor

@lockewritesdocs lockewritesdocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a minor, suggested change, but LGTM 👍

docs/reference/settings/notification-settings.asciidoc Outdated Show resolved Hide resolved
@lockewritesdocs
Copy link
Contributor

@a03nikki, does this change apply to 8.0 and 7.x as well? If so, I'll add the appropriate labels and backport accordingly.

@a03nikki
Copy link
Contributor Author

a03nikki commented Jan 26, 2022

@lockewritesdocs : Yes. My understanding from looking at #44460 it applies to 7.3+. I found it while working with a 7.16 Elasticsearch cluster.

Co-authored-by: Adam Locke <adam.locke@elastic.co>
@lockewritesdocs lockewritesdocs added v7.16.3 v7.17.1 v8.0.0 auto-backport-and-merge v7.14.2 v7.15.2 and removed external-contributor Pull request authored by a developer outside the Elasticsearch team labels Jan 27, 2022
@lockewritesdocs lockewritesdocs merged commit 5b6164f into master Jan 27, 2022
@lockewritesdocs lockewritesdocs deleted the a03nikki/docs-watcher-csv-warning branch January 27, 2022 14:23
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jan 27, 2022
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jan 27, 2022
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>
lockewritesdocs pushed a commit that referenced this pull request Jan 27, 2022
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Nicole Albee <2642763+a03nikki@users.noreply.github.com>
lockewritesdocs pushed a commit that referenced this pull request Jan 27, 2022
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Nicole Albee <2642763+a03nikki@users.noreply.github.com>
lockewritesdocs pushed a commit that referenced this pull request Jan 27, 2022
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Nicole Albee <2642763+a03nikki@users.noreply.github.com>
a03nikki added a commit to a03nikki/elasticsearch that referenced this pull request Jan 27, 2022
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
7.14
7.15

a03nikki added a commit to a03nikki/elasticsearch that referenced this pull request Jan 27, 2022
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
7.14
7.15

elasticsearchmachine pushed a commit that referenced this pull request Jan 27, 2022
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>
elasticsearchmachine pushed a commit that referenced this pull request Jan 27, 2022
* Update docs for Watcher notification settings to include default xpack.notification.reporting.warning.kbn-csv-contains-formulas.text value and link to the Kibana documentation.

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

* Apply suggestions from code review

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>

Co-authored-by: Adam Locke <adam.locke@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants