-
Notifications
You must be signed in to change notification settings - Fork 86
Add Category Proposal issue template #1033
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| name: Category Proposal | ||
| about: For proposing and discussing a change to the list of categories available under the Elastic Package Specification | ||
| labels: discuss | ||
| title: "[Category Proposal] " | ||
| --- | ||
|
|
||
| *Please read the section on [Category Proposals in the Contributing Guide](../../CONTRIBUTING.md#category-proposals) and flesh out this issue accordingly. Thank you!* | ||
|
|
||
| ## Context | ||
|
|
||
| <!-- Provide some background context on why this new category is needed. --> | ||
|
|
||
| ## Eligibility Requirements | ||
|
|
||
| Please, address the following to make sure the propsal is elegible: | ||
|
|
||
| - [ ] New category must group at least 5 integrations, existing or planned. List them here. | ||
| - [ ] Alternative existing categories in which these integrations are (currently) or could be (in the future) grouped. | ||
| - [ ] Proof that this label is a well-known industry term and not jargon used by a few. | ||
| - Usage of the keyword in Gartner or Forrester industry reports. | ||
| - Industry blogs using this label or keyword. | ||
| - Customer mentioning this keyword. | ||
| - [ ] Proof that users use this label to describe this subset of integrations. | ||
| - Enhancement requests that complain about the lack of this category. | ||
| - Full-story data reporting on average 50+ unique searches for this keyword per month in the integrations UI. | ||
| - Usage of this category for filtering purposes by our industry. | ||
| - [ ] Impact that are we expecting with this category and how we will measure it (success criteria) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure about possible answers to this point. @nimarezainia are we checking some telemetry related to categories? |
||
|
|
||
| ## Implementation checklist | ||
|
|
||
| - [ ] Support in package-spec manifest categories | ||
| - [ ] Support in package-registry /categories API | ||
| - [ ] Support in Fleet | ||
| - [ ] Update integrations dependencies to support new category | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,6 +29,20 @@ something like this: | |
| 5. No single PR may close the proposal issue. But as these PRs get resolved, the corresponding checklist item should be | ||
| checked off. The proposal issue is closed when all items are checked off. | ||
|
|
||
| ## Category Proposals | ||
|
|
||
| Any changes on the categories supported by the Elastic Package Specification has to be discussed. The process is: | ||
|
|
||
| 1. A solutions team or an integration author creates a | ||
| [Category Proposal issue](https://github.com/elastic/package-spec/issues/new/choose) | ||
| in the package-spec repo requesting the addition of a new category. | ||
| 2. Github issue provides details related to the category i.e. label, position, solution, etc. Answers to all the points in | ||
| the eligibility requirement and a plan or timeline to add a promised minimum set of integrations. | ||
| 3. Ecosystem team assesses the request and makes a decision based on data points provided in the GitHub issue | ||
| 4. If we are not able to address and the category doesn’t meet eligibility requirements, we can assume that | ||
| this category is more harmful to the UX than the value it provides, and hence, it must not be added. | ||
| 5. If the decision is in favor of adding the category, the Ecosystem team will prioritize and work on the GitHub issue in | ||
| one of the releases under planning (future releases) | ||
|
Comment on lines
+41
to
+45
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. According to this , should this issue be added the |
||
|
|
||
| ## Folder Item spec | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.