-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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
add platform team definition of done #59993
Merged
+37
−11
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,33 @@ | ||
# Kibana Conventions | ||
|
||
- [Kibana Conventions](#kibana-conventions) | ||
- [Organisational Conventions](#organisational-conventions) | ||
- [Definition of done](#definition-of-done) | ||
- [Technical Conventions](#technical-conventions) | ||
- [Plugin Structure](#plugin-structure) | ||
- [The PluginInitializer](#the-plugininitializer) | ||
- [The Plugin class](#the-plugin-class) | ||
- [Applications](#applications) | ||
- [Services](#services) | ||
- [Usage Collection](#usage-collection) | ||
- [Saved Objects Types](#saved-objects-types) | ||
|
||
## Plugin Structure | ||
- [Naming conventions](#naming-conventions) | ||
|
||
## Organisational Conventions | ||
### Definition of done | ||
Definition of done for a feature: | ||
- has a dedicated Github issue describing problem space | ||
- an umbrella task closed/updated with follow-ups | ||
- all code review comments are resolved | ||
- works for OSS version | ||
- works for the commercial version with a license | ||
- for a logged-in user | ||
- for anonymous user | ||
- compatible with Spaces | ||
mshustov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- can be used by the first & third party plugins | ||
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. NIT: remove |
||
- has unit & integration tests for public contracts | ||
- has functional tests for user scenarios | ||
- has documentation for the public contract, provides a usage example | ||
|
||
## Technical Conventions | ||
### Plugin Structure | ||
|
||
All Kibana plugins built at Elastic should follow the same structure. | ||
|
||
|
@@ -60,7 +78,7 @@ my_plugin/ | |
- More should be fleshed out here... | ||
- Usage collectors for Telemetry should be defined in a separate `server/collectors/` directory. | ||
|
||
### The PluginInitializer | ||
#### The PluginInitializer | ||
|
||
```ts | ||
// my_plugin/public/index.ts | ||
|
@@ -75,7 +93,7 @@ export { | |
} | ||
``` | ||
|
||
### The Plugin class | ||
#### The Plugin class | ||
|
||
```ts | ||
// my_plugin/public/plugin.ts | ||
|
@@ -130,7 +148,7 @@ Difference between `setup` and `start`: | |
|
||
The bulk of your plugin logic will most likely live inside _handlers_ registered during `setup`. | ||
|
||
### Applications | ||
#### Applications | ||
|
||
It's important that UI code is not included in the main bundle for your plugin. Our webpack configuration supports | ||
dynamic async imports to split out imports into a separate bundle. Every app's rendering logic and UI code should | ||
|
@@ -175,7 +193,7 @@ export class MyPlugin implements Plugin { | |
} | ||
``` | ||
|
||
### Services | ||
#### Services | ||
|
||
Service structure should mirror the plugin lifecycle to make reasoning about how the service is executed more clear. | ||
|
||
|
@@ -226,7 +244,7 @@ export class Plugin { | |
} | ||
``` | ||
|
||
### Usage Collection | ||
#### Usage Collection | ||
|
||
For creating and registering a Usage Collector. Collectors should be defined in a separate directory `server/collectors/`. You can read more about usage collectors on `src/plugins/usage_collection/README.md`. | ||
|
||
|
@@ -263,7 +281,7 @@ export function registerMyPluginUsageCollector(usageCollection?: UsageCollection | |
} | ||
``` | ||
|
||
### Saved Objects Types | ||
#### Saved Objects Types | ||
|
||
Saved object type definitions should be defined in their own `server/saved_objects` directory. | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Isn't that more in the 'Definition of Ready'?
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.
Agree, do we want to have a separate document? We can keep it here for the time being.
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.
Keeping it there for now is fine.