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

[Actions][Docs] Modify connector documentation with the new MS Exchange online configuration requirements #112768

Merged
merged 13 commits into from
Oct 6, 2021

Conversation

YulNaumenko
Copy link
Contributor

@YulNaumenko YulNaumenko commented Sep 22, 2021

Resolves #111449

This PR is adding documentation for Microsoft Exchange email connector and UI placeholders with help links.
Link for testing docs: https://kibana_112768.docs-preview.app.elstc.co/guide/en/kibana/master/email-action-type.html#exchange

Screen Shot 2021-09-26 at 7 59 35 PM

### Checklist

Delete any items that are not applicable to this PR.

  • Documentation was added for features that require explanation or tutorials

@YulNaumenko YulNaumenko self-assigned this Sep 22, 2021
@YulNaumenko YulNaumenko added documentation Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX v7.16.0 v8.0.0 release_note:skip Skip the PR/issue when compiling release notes labels Sep 27, 2021
@YulNaumenko YulNaumenko marked this pull request as ready for review September 27, 2021 03:01
@YulNaumenko YulNaumenko requested review from a team as code owners September 27, 2021 03:01
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@YulNaumenko YulNaumenko requested a review from gchaps September 27, 2021 03:01
@YulNaumenko
Copy link
Contributor Author

@elasticmachine merge upstream

@YulNaumenko YulNaumenko requested a review from a team September 28, 2021 16:12
@ymao1
Copy link
Contributor

ymao1 commented Sep 30, 2021

What do you think about moving this to a separate sub-page? This section takes up a lot of space now. Interested to hear what @elastic/kibana-docs think as well.

docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
docs/management/connectors/action-types/email.asciidoc Outdated Show resolved Hide resolved
@YulNaumenko
Copy link
Contributor Author

@elasticmachine merge upstream

@YulNaumenko YulNaumenko requested a review from gchaps October 4, 2021 18:22
@YulNaumenko
Copy link
Contributor Author

What do you think about moving this to a separate sub-page? This section takes up a lot of space now. Interested to hear what @elastic/kibana-docs think as well.

@ymao1 your suggestion makes sense, but in this case we will get more nested levels of the docs which is worse supported by the new documents system. @gchaps any thoughts on this? Can we have it as it is or a better approach will be a splitting provider specific docs to a subpages?

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
@gchaps
Copy link
Contributor

gchaps commented Oct 4, 2021

for now, i would leave the page as is. the hierarchy in the new docs system will be much flatter. we can revisit after we move the docs.

Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

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

Docs look great! Left one comment about adding some separation between the deprecated config and the new config and there is one screenshot on the email docs page that would be nice to update with a new screenshot showing the service dropdown.

@YulNaumenko YulNaumenko requested a review from ymao1 October 6, 2021 03:48
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
triggersActionsUi 757.7KB 758.7KB +979.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
core 298.7KB 298.8KB +167.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @YulNaumenko

Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

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

It would help if I click Approve :)

Copy link
Contributor

@chrisronline chrisronline left a comment

Choose a reason for hiding this comment

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

LGTM!

[role="screenshot"]
image::management/connectors/images/exchange-secrets.png[MS Exchange secrets configuration]

Add a new client secret, then copy the value and put it to the proper field in the Microsoft Exchange email connector.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add a screenshot of where this goes in the UI?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we have a bunch now, probably when the SDH comes :-)

@YulNaumenko YulNaumenko merged commit b9db370 into elastic:master Oct 6, 2021
YulNaumenko added a commit to YulNaumenko/kibana that referenced this pull request Oct 6, 2021
…ge online configuration requirements (elastic#112768)

* [Actions][Docs] Modify connector documentation with the new MS Exchange online configuration requirements

* Added images

* Added client secrets

* fixed test

* fixed links

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed due to comments

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update email.asciidoc

* fixed due to comments

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
YulNaumenko added a commit that referenced this pull request Oct 6, 2021
…ge online configuration requirements (#112768) (#114170)

* [Actions][Docs] Modify connector documentation with the new MS Exchange online configuration requirements

* Added images

* Added client secrets

* fixed test

* fixed links

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed due to comments

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update email.asciidoc

* fixed due to comments

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.16.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Actions][Docs] Modify connector documentation with the new MS Exchange online configuration requirements
7 participants