-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into ml-apm-correlations-api-integration-tests
- Loading branch information
Showing
464 changed files
with
11,125 additions
and
2,186 deletions.
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
Validating CODEOWNERS rules …
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,85 @@ | ||
--- | ||
id: kibDevTutorialSubmitPullRequest | ||
slug: /kibana-dev-docs/tutorial/submit-pull-request | ||
title: Submitting a Kibana pull request | ||
summary: Learn how to submit a Kibana pull request | ||
date: 2021-06-24 | ||
tags: ['kibana', 'onboarding', 'dev', 'tutorials', 'github', 'pr', 'pull request', 'ci'] | ||
--- | ||
|
||
## Create and clone a fork of Kibana | ||
|
||
Kibana has hundreds of developers, some of whom are outside of Elastic, so we use a fork-based approach for creating branches and pull requests. | ||
|
||
To create and clone a fork: | ||
|
||
1. Login to [GitHub](https://github.com) | ||
2. Navigate to the [Kibana repository](https://github.com/elastic/kibana) | ||
3. Follow the [GitHub instructions](https://docs.github.com/en/get-started/quickstart/fork-a-repo) for forking and cloning repos | ||
|
||
## Create a branch | ||
|
||
After cloning your fork and navigating to the directory containing your fork: | ||
|
||
```bash | ||
# Make sure you currently have the branch checked out off of which you'd like to work | ||
git checkout master | ||
|
||
# Create a new branch | ||
git checkout -b fix-typos-in-readme | ||
|
||
# Edit some code | ||
vi README.md | ||
|
||
# Add/commit the change | ||
git add README.md | ||
git commit -m "Fixed all of the typos in the README" | ||
|
||
# Push the branch to your fork | ||
git push -u origin fix-typos-in-readme | ||
``` | ||
|
||
If this is a new branch, you will see a link in your terminal that points you directly to a page to create a pull request for that branch. | ||
|
||
## Create a pull request | ||
|
||
1. Navigate to your fork in Github | ||
2. If you see your branch at the top of the screen with a `Compare & pull request` button, click that. Otherwise: | ||
1. Navigate to your branch | ||
2. Click Contribute, followed by `Open pull request` | ||
3. Fill out the details that are relevant for your change in the pull request template | ||
1. If your pull request relates to an open issue, you can also reference that issue here, e.g. `Closes #12345` | ||
4. [Elastic employees only] Add any teams/people that need to review your code under Reviewers. There's a good chance one or more teams will automatically be added based on which part of the codebase in which your changes were made. | ||
5. [Elastic employees only] Add any relevant labels | ||
1. Versions: Add a label for each version of Kibana in which your change will ship. For example, `v8.0.0`, `v7.14.0` | ||
2. Features: Add labels for any relevant feature areas, e.g. `Feature:Development` | ||
3. Team: Most PRs should have at least one `Team:` label. Add labels for teams that should follow or are responsible for the pull request. | ||
4. Release Note: Add `release_note:skip` if this pull request should not automatically get added to release notes for Kibana | ||
5. Auto Backport: Add `auto-backport` if you'd like your pull request automatically backported to all labeled versions. | ||
6. Submit the pull request. If it's not quite ready for review, it can also be submitted as a Draft pull request. | ||
|
||
![Screenshot of Compare and pull request header](../assets/pr_header.png) | ||
|
||
![Screenshot of opening a pull request from the branch page](../assets/pr_open.png) | ||
|
||
![Screenshot of pull request details](../assets/pr_details.png) | ||
|
||
## Sign the Contributor Agreement | ||
|
||
If this is your first pull request, a bot will post a comment asking you to sign our [CLA / Contributor Agreement](https://www.elastic.co/contributor-agreement). Your pull request won't be able to be merged until you've reviewed and signed the agreement. | ||
|
||
## Review Process | ||
|
||
At this point, your pull request will be reviewed, discussed, etc. Changes will likely be requested. For complex pull requests, this process could take several weeks. Please be patient and understand we hold our code base to a high standard. | ||
|
||
See [Pull request review guidelines](https://www.elastic.co/guide/en/kibana/master/pr-review.html) for our general philosophy for pull request reviews. | ||
|
||
## Updating your PR with upstream | ||
|
||
If your pull request hasn't been updated with the latest code from the upstream/target branch, e.g. `master`, in the last 48 hours, it won't be able to merge until it is updated. This is to help prevent problems that could occur by merging stale code into upstream, e.g. something new was recently merged that is incompatible with something in your pull request. | ||
|
||
As an alternative to using `git` to manually update your branch, you can leave a comment on your pull request with the text `@elasticmachine merge upstream`. This will automatically update your branch and kick off CI for it. | ||
|
||
## Re-triggering CI | ||
|
||
The easiest way to re-trigger CI is to simply update your branch (see above) with the latest code from upstream. This has the added benefit of ensuring that your branch is up-to-date and compatible. |
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
13 changes: 13 additions & 0 deletions
13
...development/core/public/kibana-plugin-core-public.corestart.executioncontext.md
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [CoreStart](./kibana-plugin-core-public.corestart.md) > [executionContext](./kibana-plugin-core-public.corestart.executioncontext.md) | ||
|
||
## CoreStart.executionContext property | ||
|
||
[ExecutionContextServiceStart](./kibana-plugin-core-public.executioncontextservicestart.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
executionContext: ExecutionContextServiceStart; | ||
``` |
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
19 changes: 19 additions & 0 deletions
19
...nt/core/public/kibana-plugin-core-public.executioncontextservicestart.create.md
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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextServiceStart](./kibana-plugin-core-public.executioncontextservicestart.md) > [create](./kibana-plugin-core-public.executioncontextservicestart.create.md) | ||
|
||
## ExecutionContextServiceStart.create property | ||
|
||
Creates a context container carrying the meta-data of a runtime operation. Provided meta-data will be propagated to Kibana and Elasticsearch servers. | ||
|
||
```js | ||
const context = executionContext.create(...); | ||
http.fetch('/endpoint/', { context }); | ||
|
||
``` | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
create: (context: KibanaExecutionContext) => IExecutionContextContainer; | ||
``` |
25 changes: 25 additions & 0 deletions
25
...velopment/core/public/kibana-plugin-core-public.executioncontextservicestart.md
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 |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [ExecutionContextServiceStart](./kibana-plugin-core-public.executioncontextservicestart.md) | ||
|
||
## ExecutionContextServiceStart interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface ExecutionContextServiceStart | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [create](./kibana-plugin-core-public.executioncontextservicestart.create.md) | <code>(context: KibanaExecutionContext) => IExecutionContextContainer</code> | Creates a context container carrying the meta-data of a runtime operation. Provided meta-data will be propagated to Kibana and Elasticsearch servers. | ||
```js | ||
const context = executionContext.create(...); | ||
http.fetch('/endpoint/', { context }); | ||
|
||
``` | ||
| | ||
|
11 changes: 11 additions & 0 deletions
11
docs/development/core/public/kibana-plugin-core-public.httpfetchoptions.context.md
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 |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [HttpFetchOptions](./kibana-plugin-core-public.httpfetchoptions.md) > [context](./kibana-plugin-core-public.httpfetchoptions.context.md) | ||
|
||
## HttpFetchOptions.context property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
context?: IExecutionContextContainer; | ||
``` |
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
19 changes: 19 additions & 0 deletions
19
...development/core/public/kibana-plugin-core-public.iexecutioncontextcontainer.md
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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExecutionContextContainer](./kibana-plugin-core-public.iexecutioncontextcontainer.md) | ||
|
||
## IExecutionContextContainer interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface IExecutionContextContainer | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [toHeader](./kibana-plugin-core-public.iexecutioncontextcontainer.toheader.md) | <code>() => Record<string, string></code> | | | ||
|
11 changes: 11 additions & 0 deletions
11
...nt/core/public/kibana-plugin-core-public.iexecutioncontextcontainer.toheader.md
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 |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [IExecutionContextContainer](./kibana-plugin-core-public.iexecutioncontextcontainer.md) > [toHeader](./kibana-plugin-core-public.iexecutioncontextcontainer.toheader.md) | ||
|
||
## IExecutionContextContainer.toHeader property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
toHeader: () => Record<string, string>; | ||
``` |
13 changes: 13 additions & 0 deletions
13
...ent/core/public/kibana-plugin-core-public.kibanaexecutioncontext.description.md
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) > [description](./kibana-plugin-core-public.kibanaexecutioncontext.description.md) | ||
|
||
## KibanaExecutionContext.description property | ||
|
||
human readable description. For example, a vis title, action name | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly description: string; | ||
``` |
13 changes: 13 additions & 0 deletions
13
.../development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.id.md
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) > [id](./kibana-plugin-core-public.kibanaexecutioncontext.id.md) | ||
|
||
## KibanaExecutionContext.id property | ||
|
||
unique value to indentify find the source | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly id: string; | ||
``` |
23 changes: 23 additions & 0 deletions
23
docs/development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.md
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 |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) | ||
|
||
## KibanaExecutionContext interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface KibanaExecutionContext | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [description](./kibana-plugin-core-public.kibanaexecutioncontext.description.md) | <code>string</code> | human readable description. For example, a vis title, action name | | ||
| [id](./kibana-plugin-core-public.kibanaexecutioncontext.id.md) | <code>string</code> | unique value to indentify find the source | | ||
| [name](./kibana-plugin-core-public.kibanaexecutioncontext.name.md) | <code>string</code> | public name of a user-facing feature | | ||
| [type](./kibana-plugin-core-public.kibanaexecutioncontext.type.md) | <code>string</code> | Kibana application initated an operation. Can be narrowed to an enum later. | | ||
| [url](./kibana-plugin-core-public.kibanaexecutioncontext.url.md) | <code>string</code> | in browser - url to navigate to a current page, on server - endpoint path, for task: task SO url | | ||
|
13 changes: 13 additions & 0 deletions
13
...evelopment/core/public/kibana-plugin-core-public.kibanaexecutioncontext.name.md
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) > [name](./kibana-plugin-core-public.kibanaexecutioncontext.name.md) | ||
|
||
## KibanaExecutionContext.name property | ||
|
||
public name of a user-facing feature | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly name: string; | ||
``` |
13 changes: 13 additions & 0 deletions
13
...evelopment/core/public/kibana-plugin-core-public.kibanaexecutioncontext.type.md
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) > [type](./kibana-plugin-core-public.kibanaexecutioncontext.type.md) | ||
|
||
## KibanaExecutionContext.type property | ||
|
||
Kibana application initated an operation. Can be narrowed to an enum later. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly type: string; | ||
``` |
13 changes: 13 additions & 0 deletions
13
...development/core/public/kibana-plugin-core-public.kibanaexecutioncontext.url.md
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [KibanaExecutionContext](./kibana-plugin-core-public.kibanaexecutioncontext.md) > [url](./kibana-plugin-core-public.kibanaexecutioncontext.url.md) | ||
|
||
## KibanaExecutionContext.url property | ||
|
||
in browser - url to navigate to a current page, on server - endpoint path, for task: task SO url | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly url?: string; | ||
``` |
Oops, something went wrong.