Skip to content
This repository was archived by the owner on Aug 16, 2022. It is now read-only.

Commit 1e3b832

Browse files
authored
Merge pull request #327 from ashwinkumar12345/notebooks
Notebooks
2 parents 4536b4f + 63a434b commit 1e3b832

File tree

6 files changed

+64
-0
lines changed

6 files changed

+64
-0
lines changed

docs/images/kibana-notebooks.gif

10.2 MB
Loading

docs/images/markdown-notebook.png

121 KB
Loading

docs/images/notebook.png

198 KB
Loading

docs/images/output-notebook.png

764 KB
Loading
155 KB
Loading

docs/notebooks/index.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
layout: default
3+
title: Notebook
4+
nav_order: 38
5+
has_children: false
6+
---
7+
8+
# Kibana Notebook
9+
10+
A Kibana notebook is an interface that lets you easily combine live visualizations and narrative text in a single notebook interface.
11+
12+
With Kibana notebooks, you can interactively explore data by running different visualizations and share your work with team members to collaborate on a project.
13+
14+
You can add visualization paragraphs for creating graphs and markdown paragraphs for writing descriptions. You can choose multiple timelines to compare and contrast visualizations.
15+
16+
Common use cases include creating postmortem reports, designing runbooks, building live infrastructure reports, and writing documentation.
17+
18+
## Get Started with Notebooks
19+
20+
To get started, choose **Kibana Notebooks** in Kibana.
21+
22+
### Step 1: Create a notebook
23+
24+
A notebook is an interface for creating reports.
25+
26+
1. Choose **Create notebook** and enter a descriptive name.
27+
1. Choose **Create**.
28+
29+
![Notebook UI](../images/notebook.png)
30+
31+
Choose **Notebook actions** to rename, duplicate, or delete a notebook.
32+
33+
### Step 2: Add a paragraph
34+
35+
Paragraphs combine text and visualizations for describing data.
36+
37+
#### Add a markdown paragraph
38+
39+
1. To add text, choose **Add markdown paragraph**.
40+
1. Add rich text with markdown syntax.
41+
42+
![Markdown paragraph](../images/markdown-notebook.png)
43+
44+
#### Add a visualization paragraph
45+
46+
1. To add a visualization, choose **Add Kibana visualization paragraph**.
47+
1. In **Title**, select your visualization and choose a date range.
48+
49+
![Markdown paragraph](../images/visualization-notebook.png)
50+
51+
- You can choose multiple timelines to compare and contrast visualizations.
52+
53+
To run and save a paragraph, choose **Run**.
54+
55+
![Output](../images/output-notebook.png)
56+
57+
You can perform the following actions on paragraphs:
58+
59+
- Add a new paragraph to the top of a report.
60+
- Add a new paragraph to the bottom of a report.
61+
- Run all the paragraphs at the same time.
62+
- Clear the outputs of all paragraphs.
63+
- Delete all the paragraphs.
64+
- Move paragraphs up and down.

0 commit comments

Comments
 (0)