mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
Clean up Developer Guide (#108259)
* update plugin docs * address code review feedback
This commit is contained in:
parent
db9407c47c
commit
21b080b61b
6 changed files with 104 additions and 66 deletions
37
dev_docs/getting_started/add_data.mdx
Normal file
37
dev_docs/getting_started/add_data.mdx
Normal file
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
id: kibDevAddData
|
||||
slug: /kibana-dev-docs/tutorial/sample-data
|
||||
title: Add data
|
||||
summary: Learn how to add data to Kibana
|
||||
date: 2021-08-11
|
||||
tags: ['kibana', 'onboarding', 'dev', 'architecture', 'tutorials']
|
||||
---
|
||||
|
||||
Building a feature and need an easy way to test it out with some data? Below are three options.
|
||||
|
||||
## 1. Add Sample Data from the UI
|
||||
|
||||
Kibana ships with sample data that you can install at the click of the button. If you are building a feature and need some data to test it out with, sample data is a great option. The only limitation is that this data will not work for Security or Observability solutions (see [#62962](https://github.com/elastic/kibana/issues/62962)).
|
||||
|
||||
1. Navigate to the home page.
|
||||
2. Click **Add data**.
|
||||
3. Click on the **Sample data** tab.
|
||||
4. Select a dataset by clicking on the **Add data** button.
|
||||
|
||||

|
||||
|
||||
## CSV Upload
|
||||
|
||||
1. If you don't have any data, navigate to Stack Management > Index Patterns and click the link to the uploader. If you do have data, navigate to the **Machine Learning** application.
|
||||
2. Click on the **Data Visualizer** tab.
|
||||
3. Click on **Select file** in the **Import data** container.
|
||||
|
||||

|
||||
|
||||
## makelogs
|
||||
|
||||
The makelogs script generates sample web server logs. Make sure Elasticsearch is running before running the script.
|
||||
|
||||
```sh
|
||||
node scripts/makelogs --auth <username>:<password>
|
||||
```
|
|
@ -14,7 +14,8 @@ Kibana ships with many out-of-the-box capabilities that can be extended and enha
|
|||
Recommended next reading:
|
||||
|
||||
1. <DocLink id="kibDevTutorialSetupDevEnv" text="Set up your development environment" />
|
||||
2. Create a simple <DocLink id="kibHelloWorldApp" text="Hello World plugin"/>.
|
||||
2. Create a <DocLink id="kibHelloWorldApp" text="Hello World plugin"/>.
|
||||
3. <DocLink id="kibDevAddData" text="Add data" />.
|
||||
|
||||
Check out our <DocLink id="kibDevDocsApiWelcome" text="API documentation" /> to dig into the nitty gritty details of
|
||||
every public plugin API.
|
||||
|
|
|
@ -27,7 +27,7 @@ $ mkdir hello_world
|
|||
$ cd hello_world
|
||||
```
|
||||
|
||||
2. Create the <DocLink id="kibDevTutorialBuildAPlugin" section="1-kibanajson" text="kibana.json manifest file"/>.
|
||||
2. Create the <DocLink id="kibDevAnatomyOfAPlugin" section="kibanajson" text="kibana.json manifest file"/>.
|
||||
|
||||
```
|
||||
$ touch kibana.json
|
||||
|
@ -44,7 +44,7 @@ and add the following:
|
|||
}
|
||||
```
|
||||
|
||||
3. Create a `tsconfig.json` file.
|
||||
3. Create a <DocLink id="kibDevAnatomyOfAPlugin" section="tsconfigjson" text="tsconfig.json file" />.
|
||||
|
||||
```
|
||||
$ touch tsconfig.json
|
||||
|
@ -56,8 +56,7 @@ And add the following to it:
|
|||
{
|
||||
"extends": "../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "./target",
|
||||
"skipLibCheck": true
|
||||
"outDir": "./target/types",
|
||||
},
|
||||
"include": [
|
||||
"index.ts",
|
||||
|
@ -67,11 +66,14 @@ And add the following to it:
|
|||
"server/**/*.ts",
|
||||
"../../typings/**/*"
|
||||
],
|
||||
"exclude": []
|
||||
"exclude": [],
|
||||
"references": [
|
||||
{ "path": "../../src/core/tsconfig.json" }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
4. Create a <DocLink id="kibDevTutorialBuildAPlugin" section="2-publicindexts" text="`public/plugin.tsx` file "/>.
|
||||
4. Create a <DocLink id="kibDevAnatomyOfAPlugin" section="publicindexts" text="`public/plugin.tsx` file "/>.
|
||||
|
||||
```
|
||||
$ mkdir public
|
||||
|
@ -104,7 +106,7 @@ export class HelloWorldPlugin implements Plugin {
|
|||
}
|
||||
```
|
||||
|
||||
5. Create a <DocLink id="kibDevTutorialBuildAPlugin" section="3-publicplugints" text="`public/index.ts` file "/>.
|
||||
5. Create a <DocLink id="kibDevAnatomyOfAPlugin" section="publicplugints" text="`public/index.ts` file "/>.
|
||||
|
||||
```
|
||||
$ touch index.ts
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue