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

Split out connector documentation into individual sections #62445

Closed
alexfrancoeur opened this issue Apr 3, 2020 · 8 comments · Fixed by #63516
Closed

Split out connector documentation into individual sections #62445

alexfrancoeur opened this issue Apr 3, 2020 · 8 comments · Fixed by #63516
Assignees
Labels
Feature:Actions Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@alexfrancoeur
Copy link

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

@alexfrancoeur alexfrancoeur added Feature:Alerting Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Apr 3, 2020
@elasticmachine
Copy link
Contributor

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

@gchaps
Copy link
Contributor

gchaps commented Apr 3, 2020

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.

@peterschretlen
Copy link
Contributor

++ 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).

@alexfrancoeur
Copy link
Author

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

@alexfrancoeur
Copy link
Author

alexfrancoeur commented Apr 14, 2020

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?

https://www.elastic.co/guide/en/kibana/current/[action name].html or
https://www.elastic.co/guide/en/kibana/current/action-types/[action name].html

@alexfrancoeur
Copy link
Author

Great, thanks Mike! I'll move forward with this assumption, let me know if anything changes

@mikecote
Copy link
Contributor

@alexfrancoeur @arisonl the documentation is now live with the split:

@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Actions Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants