-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Split out connector documentation into individual sections #62445
Comments
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
Separating the connectors into individual sections would be equivalent to how connectors are documented in the Elasticsearch docs. It would also leave room to provide some examples. |
++ what's there is minimal, it would be great to build on it by separating out each action and showing screenshots of both connector and action UIs (the current page combines the parameters for both, which can be somewhat confusing). |
Something similar that might help for inspiration, workplace search content sources: https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources.html While focusing on one integration initially, we'll need to provide more detailed documentation for each connector shortly after. @arisonl and I can help with this |
Just to be proactive, is there any way we can share the URL structure ahead of time? Would be it a simple deep link or do we need a hierarchy?
|
@alexfrancoeur working on this locally, what I have so far is the following:
So it would be the former I believe. |
Great, thanks Mike! I'll move forward with this assumption, let me know if anything changes |
@alexfrancoeur @arisonl the documentation is now live with the split: |
Our docs look great for alerts and actions (thanks @peterschretlen!). I'm opening this issue to split out connectors into their own individual sections. As this library grows, we'll probably need that regardless. But as we begin to work with some of these companies, it'll be easier for us to link out to integrations in our documentation if they're separate sections. It also allows us to go into a little more detail with screenshots, etc.
https://www.elastic.co/guide/en/kibana/7.x/action-types.html
cc: @gchaps @arisonl
The text was updated successfully, but these errors were encountered: