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

Catch-up release documentation #92411

Merged
merged 8 commits into from
Feb 23, 2021
Merged

Catch-up release documentation #92411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c02aa7e
Initial commit
mikecote Feb 23, 2021
b44190d
Undo custom id docs (done in separate PR)
mikecote Feb 23, 2021
9a88504
Update docs, a bit
mikecote Feb 23, 2021
11b2ce3
fix create api doc
mikecote Feb 23, 2021
183531b
Update docs/user/alerting/action-types/email.asciidoc
mikecote Feb 23, 2021
e28798e
Update docs/user/alerting/alerting-getting-started.asciidoc
mikecote Feb 23, 2021
b24a4b1
Indent warning
mikecote Feb 23, 2021
21e0d67
Merge branch 'alerting/docs-catch-up' of github.com:mikecote/kibana i…
mikecote Feb 23, 2021
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
2 changes: 2 additions & 0 deletions docs/api/actions-and-connectors/create.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Creates an action.
`secrets`::
(Required, object) The secrets configuration for the action. Secrets configuration properties vary
depending on the action type. For information about the secrets configuration properties, refer to <<action-types,Action and connector types>>.
+
WARNING: Remember these values. You must provide them each time you call the <<actions-and-connectors-api-update, update>> API.
Copy link
Contributor

Choose a reason for hiding this comment

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

If this note is specific to secrets, then it should be indented under secrets. Adding a "+" to the blank line above the warning should do the trick.

Copy link
Contributor Author

@mikecote mikecote Feb 23, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

That's correct because it is specific to secrets. Adding + to the line above worked, thanks! Fixed in b24a4b1 ready for re-review.


[[actions-and-connectors-api-create-request-codes]]
==== Response code
Expand Down
2 changes: 2 additions & 0 deletions docs/user/alerting/action-types/email.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

The email action type uses the SMTP protocol to send mail message, using an integration of https://nodemailer.com/[Nodemailer]. Email message text is sent as both plain text and html text.

NOTE: For emails to have a footer with a link back to {kib}, set the <<server-publicBaseUrl, `server.publicBaseUrl`>> configuration setting.

[float]
[[email-connector-configuration]]
==== Connector configuration
Expand Down
1 change: 1 addition & 0 deletions docs/user/alerting/alerting-getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ Pre-packaged *alert types* simplify setup, hide the details complex domain-speci
If you are using an *on-premises* Elastic Stack deployment:

* In the kibana.yml configuration file, add the <<alert-action-settings-kb,`xpack.encryptedSavedObjects.encryptionKey`>> setting.
* For emails to have a footer with a link back to {kib}, set the <<server-publicBaseUrl, `server.publicBaseUrl`>> configuration setting.

If you are using an *on-premises* Elastic Stack deployment with <<using-kibana-with-security, *security*>>:

Expand Down