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.

Sign up for GitHub

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

Jump to bottom

documentation on how to create new Add Data tutorials. #16257

Merged
merged 7 commits into from
Jan 26, 2018
Merged

documentation on how to create new Add Data tutorials. #16257

merged 7 commits into from
Jan 26, 2018

Conversation

nreese
Copy link
Contributor

@nreese nreese commented Jan 24, 2018 •
edited
Loading

fixes #16269

documentation on how to create new Add Data tutorials.

@nreese nreese requested a review from kobelb January 24, 2018 22:53
@nreese nreese removed the Team:Docs label Jan 24, 2018
@nreese nreese requested review from ycombinator and tsg January 24, 2018 23:34
ycombinator
ycombinator reviewed Jan 24, 2018
View reviewed changes
style_guides/add_data_tutorial_guide.md Outdated
`Add Data` in the Kibana Home application contains a collection of tutorials for setting up data flows in the Elastic stack.

Each tutorial contains 3 sets of instructions
1. `On Premise` Instructions for setting up a data flow when both Kibana and Elastic Search 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.

s/Elastic Search/Elasticsearch/

ycombinator
ycombinator reviewed Jan 24, 2018
View reviewed changes
style_guides/add_data_tutorial_guide.md Outdated
Each tutorial contains 3 sets of instructions
1. `On Premise` Instructions for setting up a data flow when both Kibana and Elastic Search are running on premise
2. `On Premise Elastic Cloud` Instructions for setting up a data flow when Kibana is running on premise but
Elastic Search is running on cloud.
Copy link
Contributor

Choose a reason for hiding this comment

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

s/Elastic Search/Elasticsearch/

ycombinator
ycombinator reviewed Jan 24, 2018
View reviewed changes
style_guides/add_data_tutorial_guide.md Outdated
1. `On Premise` Instructions for setting up a data flow when both Kibana and Elastic Search are running on premise
2. `On Premise Elastic Cloud` Instructions for setting up a data flow when Kibana is running on premise but
Elastic Search is running on cloud.
3. `Elastic Cloud` Instructions for setting up a data flow when both Kibana and Elastic Search are running on cloud.
Copy link
Contributor

Choose a reason for hiding this comment

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

s/Elastic Search/Elasticsearch/

ycombinator
ycombinator reviewed Jan 24, 2018
View reviewed changes
style_guides/add_data_tutorial_guide.md Outdated
3. `Elastic Cloud` Instructions for setting up a data flow when both Kibana and Elastic Search are running on cloud.

## Creating a new tutorial
1. Create a new folder in the [tutorials directory](https://github.com/elastic/kibana/tree/master/src/core_plugins/kibana/server/tutorials).
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: s/directory/folder/ for consistency

ycombinator
ycombinator reviewed Jan 24, 2018
View reviewed changes
style_guides/add_data_tutorial_guide.md Outdated
### Markdown
String values can contain limited markdown syntax.

[Enabled markdown grammers](https://github.com/elastic/kibana/blob/master/src/core_plugins/kibana/public/home/components/tutorial/content.js#L8)
Copy link
Contributor

Choose a reason for hiding this comment

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

Spelling: should be "grammar".

ycombinator
ycombinator reviewed Jan 24, 2018
View reviewed changes
Copy link
Contributor

@ycombinator ycombinator left a comment

Choose a reason for hiding this comment

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

Left a few minor inline comments.

Additionally, I'd suggest saying something before the "Create a PR" step about loading up Kibana and previewing the tutorial locally.

ycombinator
ycombinator reviewed Jan 25, 2018
View reviewed changes
style_guides/add_data_tutorial_guide.md Outdated
`Add Data` in the Kibana Home application contains a collection of tutorials for setting up data flows in the Elastic stack.

Each tutorial contains 3 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.

s/ElasticSearch/Elasticsearch/

ycombinator
ycombinator reviewed Jan 25, 2018
View reviewed changes
style_guides/add_data_tutorial_guide.md Outdated
Each tutorial contains 3 sets of instructions
1. `On Premise` Instructions for setting up a data flow when both Kibana and ElasticSearch are running on premise
2. `On Premise Elastic Cloud` Instructions for setting up a data flow when Kibana is running on premise but
ElasticSearch is running on cloud.
Copy link
Contributor

Choose a reason for hiding this comment

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

s/ElasticSearch/Elasticsearch/

ycombinator
ycombinator reviewed Jan 25, 2018
View reviewed changes
style_guides/add_data_tutorial_guide.md Outdated
1. `On Premise` Instructions for setting up a data flow when both Kibana and ElasticSearch are running on premise
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

s/ElasticSearch/Elasticsearch/

ycombinator
ycombinator approved these changes Jan 25, 2018
View reviewed changes
Copy link
Contributor

@ycombinator ycombinator left a comment

Choose a reason for hiding this comment

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

LGTM

gchaps
gchaps approved these changes Jan 25, 2018
View reviewed changes
Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

LGTM with a few edits.

docs/development/add-data-guide.asciidoc Outdated
[[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.
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 ....

docs/development/add-data-guide.asciidoc Outdated
=== 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)

docs/development/add-data-guide.asciidoc Outdated

[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)

docs/development/add-data-guide.asciidoc Outdated
==== Markdown
String values can contain limited markdown syntax.

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

docs/development/add-data-guide.asciidoc Outdated
@@ -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)

docs/development/add-data-guide.asciidoc Outdated

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

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:

docs/development/add-data-guide.asciidoc Outdated

Each tutorial contains 3 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.

docs/development/add-data-guide.asciidoc Outdated

[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.

docs/development/add-data-guide.asciidoc Outdated
[float]
==== Variables
String values can contain variables that get substituted when rendered. Variables are specified by `{}`.
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 ...

@nreese nreese merged commit 924d61f into elastic:master Jan 26, 2018
nreese added a commit to nreese/kibana that referenced this pull request Jan 26, 2018
@nreese
documentation on how to create new Add Data tutorials. (elastic#16257)
02cdf5f 
* tutorial docs

* fixes from ycombinator review

* ElasticSearch -> Elasticsearch

* move out of style guide and into README under server/tutorials

* move to asciidocs

* add new line so list is rendered correctly

* changes from gchaps review
@nreese nreese mentioned this pull request Jan 26, 2018
Merged
nreese added a commit that referenced this pull request Jan 26, 2018
@nreese
documentation on how to create new Add Data tutorials. (#16257) (#16326)
febcb39 
* tutorial docs

* fixes from ycombinator review

* ElasticSearch -> Elasticsearch

* move out of style guide and into README under server/tutorials

* move to asciidocs

* add new line so list is rendered correctly

* changes from gchaps review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gchaps gchaps gchaps approved these changes

@ycombinator ycombinator ycombinator approved these changes

@kobelb kobelb Awaiting requested review from kobelb

@tsg tsg Awaiting requested review from tsg

Assignees
No one assigned
Labels
Team:Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create readme instructions for adding a tutorial PR
3 participants
@nreese @ycombinator @gchaps