Skip to content
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

Merged
merged 7 commits into from
Jan 26, 2018
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/development/add-data-guide.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[[add-data-guide]]
== Add Data guide
Copy link
Contributor

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)


`Add Data` in the Kibana Home application contains a collection of tutorials for setting up data flows in the Elastic stack.
Copy link
Contributor

Choose a reason for hiding this comment

The 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each tutorial contains three sets of instructions:


1. `On Premise` Instructions for setting up a data flow when both Kibana and Elasticsearch are running on premise
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change this to a bulleted list:

  • On Premise. Set up a data flow when both Kibana and Elasticsearch are running on premise.
  • On Premise Elastic Cloud. Set up a data flow when Kibana is running on premise and Elasticsearch is running on Elastic Cloud.
  • Elastic Cloud. Set up a data flow when both Kibana and Elasticsearch are running on Elastic Cloud.

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].
Copy link
Contributor

Choose a reason for hiding this comment

The 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 `{}`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

String values can contain variables that are substituted when rendered.

For example: `{config.docs.version}` would get rendered as `6.2` when running the tutorial in Kibana 6.2.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change : to , and "would get" to "is"

For example,``{config.docs.version} is rendered as ...


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.
Copy link
Contributor

Choose a reason for hiding this comment

The 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]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

markdown -> Markdown


5 changes: 4 additions & 1 deletion docs/development/plugin-development.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The Kibana plugin interfaces are in a state of constant development. We cannot
* <<development-uiexports>>
* <<development-plugin-functional-tests>>
* <<development-visualize-index>>
* <<add-data-guide>>


include::plugin/development-plugin-resources.asciidoc[]
Expand All @@ -18,4 +19,6 @@ include::plugin/development-uiexports.asciidoc[]

include::plugin/development-plugin-functional-tests.asciidoc[]

include::visualize/development-visualize-index.asciidoc[]
include::visualize/development-visualize-index.asciidoc[]

include::add-data-guide.asciidoc[]