-
Notifications
You must be signed in to change notification settings - Fork 466
Update package descriptions #1364
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
Update package descriptions #1364
Conversation
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
Trends 🧪 |
packages/cef/manifest.yml
Outdated
@@ -2,7 +2,7 @@ name: cef | |||
title: CEF | |||
version: 0.3.0 | |||
release: experimental | |||
description: CEF Integration | |||
description: This integration collects logs from common event format (CEF) instances |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CEF isn't a product that you would run an "instance" of. It's a log format like JSON. So perhaps there is a better phrasing of this description.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, Andrew! I pulled "CEF instance" from L17 of the manifest file. Should I update that line as well to remove it? https://github.com/elastic/integrations/pull/1364/files#diff-966e13402568cef1412dea521600e7fb5172601510e51030c0bbb41d55351e43L17
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if that link will work. Here's a better one:
integrations/packages/cef/manifest.yml
Line 17 in a5e8dd2
description: Collect logs from CEF instances |
Co-authored-by: Kellen <[email protected]>
…bmorelli25/integrations into update-integration-descriptions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general we use elastic-package format
to format sources of integrations.
# Conflicts: # packages/osquery_manager/changelog.yml # packages/osquery_manager/manifest.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have requirement that CI must report green state to get the PR merged. In this case is red which means there is something wrong with this PR. There are problems with elastic_agent (missing manifest entry) and okta (missing manifest entry).
Thanks! I think everything should pass this time 🤞 |
Noooooo. Green, but a change was merged to the system integration. I'll fix the conflicts and let the tests run again. |
# Conflicts: # packages/system/changelog.yml # packages/system/manifest.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remember to bump up package versions accordingly in case of conflicts.
LGTM, feel free to merge this PR if CI is happy.
Yup. The merged update in this case happened to be a patch, so my minor update was still the latest -- just needed to merge in the new CL entry.
Thanks! I'll be clicking the button the second it's green :) |
Test just timed out. Restarting. |
Summary
This PR updates the package
manifest.yml
descriptions for every top-level package in the integrations repo. The goal of this PR is to add more descriptive descriptions as these will appear as a sub-heading on each integration's documentation page. In this first attempt, I've taken the following approach:Open to any and all feedback on this as I'm not sure how these changes impact packages elsewhere (like in Kibana). Also,
collecting
is only one part of an integration. Do we want to add other verbs likeparses
orvisualizes
?Other integrations
As far as I can tell, this PR updates all relevant integrations except APM, Endpoint, and Symantec -- which I presume live in other repos. I know where APM lives, and I think I can figure out where Endpoint and Symantec live.
Context
This is related to conversations in https://github.com/elastic/wordlake/pull/1 (sorry, internal link)