-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
documentation on how to create new Add Data tutorials. #16257
Changes from 6 commits
58f10e0
2892b71
7889b02
590e10a
46a1405
c81c5e5
5592d28
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 @@ | ||
[[add-data-guide]] | ||
== Add Data guide | ||
|
||
`Add Data` in the Kibana Home application contains a collection of tutorials for setting up data flows in the Elastic stack. | ||
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. Remove "a collection of" 'Add Data" in the Kibana Home application contains tutorials for .... |
||
|
||
Each tutorial contains 3 sets of instructions | ||
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. Each tutorial contains |
||
|
||
1. `On Premise` Instructions for setting up a data flow when both Kibana and Elasticsearch are running on premise | ||
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. Change this to a bulleted list:
|
||
2. `On Premise Elastic Cloud` Instructions for setting up a data flow when Kibana is running on premise but | ||
Elasticsearch is running on cloud. | ||
3. `Elastic Cloud` Instructions for setting up a data flow when both Kibana and Elasticsearch are running on cloud. | ||
|
||
[float] | ||
=== Creating a new tutorial | ||
1. Create a new directory in the link:https://github.com/elastic/kibana/tree/master/src/core_plugins/kibana/server/tutorials[tutorials directory]. | ||
2. In the new directory, create a file called `index.js` that exports a function. | ||
The function must return a Javascript object that conforms to the link:https://github.com/elastic/kibana/blob/master/src/core_plugins/kibana/common/tutorials/tutorial_schema.js[tutorial schema]. | ||
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. Javascript -> JavaScript (capital S) |
||
3. Register the tutorial in link:https://github.com/elastic/kibana/blob/master/src/core_plugins/kibana/server/tutorials/register.js[register.js] by calling `server.registerTutorial(myFuncImportedFromIndexJs)`. | ||
4. Add image assets to the link:https://github.com/elastic/kibana/tree/master/src/core_plugins/kibana/public/home/tutorial_resources[tutorial_resources directory]. | ||
5. Run Kibana locally to preview the tutorial. | ||
6. Create a PR and go through the review process to get the changes approved. | ||
|
||
[float] | ||
==== Variables | ||
String values can contain variables that get substituted when rendered. Variables are specified by `{}`. | ||
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. String values can contain variables |
||
For example: `{config.docs.version}` would get rendered as `6.2` when running the tutorial in Kibana 6.2. | ||
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. Change : to , and "would get" to "is" For example |
||
|
||
link:https://github.com/elastic/kibana/blob/master/src/core_plugins/kibana/public/home/components/tutorial/replace_template_strings.js#L23[Provided variables] | ||
|
||
[float] | ||
==== Markdown | ||
String values can contain limited markdown syntax. | ||
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. markdown -> Markdown (capital M) |
||
|
||
link:https://github.com/elastic/kibana/blob/master/src/core_plugins/kibana/public/home/components/tutorial/content.js#L8[Enabled markdown grammars] | ||
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. markdown -> Markdown |
||
|
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.
Add Data Guide (capital G)