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

Document unified integrations view guidelines for future package development #1903

Closed
akshay-saraswat opened this issue Oct 11, 2021 · 3 comments · Fixed by elastic/package-spec#427
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request Team:Ecosystem Label for the Packages Ecosystem team [elastic/ecosystem]

Comments

@akshay-saraswat
Copy link
Contributor

In 7.16, the Kibana team is planning to introduce the unified integrations view. And this view will aim to improve the discoverability of integrations by providing a uniform one-stop source for both beats and agent-based integrations. Integration teams associated with each Elastic app will work on updating the existing packages. But we need to capture these guidelines somewhere for future package development so that developers don't forget to align integration title and description with unified integrations view guidelines.

@akshay-saraswat akshay-saraswat added the Team:Ecosystem Label for the Packages Ecosystem team [elastic/ecosystem] label Oct 11, 2021
@jlind23
Copy link
Contributor

jlind23 commented Oct 19, 2021

@akshay-saraswat should we simply "enforce" through package spec the fields that are mandatory regarding the unified integrations?
ping @mtojek @jsoriano

@jlind23 jlind23 added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 19, 2021
@jsoriano
Copy link
Member

Do we have a list of recommendations from the Kibana team? If some of the guidelines are more "aesthetic" then it may be difficult (or impossible) to enforce with tooling.

@akshay-saraswat
Copy link
Contributor Author

@akshay-saraswat should we simply "enforce" through package spec the fields that are mandatory regarding the unified integrations? ping @mtojek @jsoriano

Guidelines are mostly around the format of title and description.
For example, Linux integration card currently has the following
Title: Linux
Description: Linux Integration

Guidelines will make it consistent with other integration cards
Title: Linux Metrics
Description: Collect metrics from Linux servers with Elastic Agent.

We are mentioning "Metrics" or "Logs" in the title when the integration collects specific data formats. And description is supposed in this format - Collect from with .

I agree with @jsoriano it will be difficult to enforce the format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request Team:Ecosystem Label for the Packages Ecosystem team [elastic/ecosystem]
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants