Tutorial copy #16135

nreese · 2018-01-18T18:46:13Z

Incorporate @gchaps changes into tutorial text.

Fix broken link on home page.

cc @alexfrancoeur @formgeist @ycombinator @tsg

ycombinator · 2018-01-18T19:13:03Z

src/core_plugins/kibana/common/tutorials/logstash_instructions.js

-        textPre: 'Download Logstash from [here](https://artifacts.elastic.co/downloads/logstash/logstash-{config.kibana.version}.zip) and unzip it.'
+        textPre: 'First time using Logstash?  See the ' +
+          '[Getting Started Guide]({config.docs.base_url}guide/en/logstash/current/getting-started-with-logstash.html).\n' +
+          '  1. Download the Logstash Windows zip file from the [Downloads page]({config.docs.base_url}downloads/logstash).\n' +


Why are we sending the user to the downloads page instead of directly to the zip file link? This means the user has to make another click to download the zip file.

Chatted with @gchaps on Slack about this. Summarizing our conversation here:

Another issue with sending the users to the download page (as opposed to the direct versioned link to the artifact) is that the download page always shows the latest version. So, for example, if Kibana 6.3 and 7.1 are released and the user is viewing this tutorial in 6.3, they might accidentally end up downloading Logstash 7.1, which might not work with their 6.3 setup. There is a link to past releases on the download page, but that's one more click + the user would have to realize that they are on the wrong version to even think of looking at past releases.

OTOH, the downside of linking directly to the versioned artifact is that we might decide to change the artifact link and forget to update the tutorial content to match.

I don't know if there's a perfect solution here but, between the two options, I think the direct versioned link to the artifact is better.

ycombinator · 2018-01-18T19:15:25Z

src/core_plugins/kibana/server/tutorials/netflow/common_instructions.js

@@ -66,25 +62,23 @@ export const COMMON_NETFLOW_INSTRUCTIONS = {
    OSX: [
      {
        title: 'Run the Netflow module',
-        textPre: 'In the Logstash installation directory, run the following command to set up the Netflow module.',
+        textPre: 'From the installation directory, run:',


We removed references to the "installation directory" earlier in this file. Should this one be removed too, for consistency?

Yes, for consistency.

ycombinator · 2018-01-18T19:18:47Z

src/core_plugins/kibana/server/tutorials/netflow/index.js

-      'dashboards to get you exploring your data immediately. Logstash modules support Netflow Version 5 and 9. [Learn more]' +
-      '({config.docs.logstash}/netflow-module.html) about the Netflow module',
+    shortDescription: 'Collect Netflow records sent by a Netflow exporter.',
+    longDescription: 'The Logstash Netflow module parses network flow data, ' +


I imagine users who end up on this page are familiar with Netflow concepts and terminlogy. In Netflow parlance a "collector" is a well-defined concept so I'd like that to be reflected here. So could we make this "collects and parses" instead of just "parses"?

It's good to use industry-standard terminology.

For some reason this PR was merged without addressing this comment. I've pushed 629f7d8 directly to master with this change now.

ycombinator · 2018-01-18T19:20:40Z

src/core_plugins/kibana/server/tutorials/netflow/index.js

+    shortDescription: 'Collect Netflow records sent by a Netflow exporter.',
+    longDescription: 'The Logstash Netflow module parses network flow data, ' +
+      ' indexes the events into Elasticsearch, and installs a suite of Kibana dashboards.' +
+      ' Logstash modules support Netflow Version 5 and 9.' +


I think there was a typo here even before this PR. I think this should say "This module supports" instead of "Logstash modules support". Mind fixing this as part of this PR?

kobelb

Technically, it looks good to me, I'll defer to the others on the exact copy though.

ycombinator · 2018-01-18T20:26:05Z

src/core_plugins/kibana/server/tutorials/netflow/index.js

@@ -11,7 +11,7 @@ export function netflowSpecProvider() {
    shortDescription: 'Collect Netflow records sent by a Netflow exporter.',
    longDescription: 'The Logstash Netflow module parses network flow data, ' +
      ' indexes the events into Elasticsearch, and installs a suite of Kibana dashboards.' +
-      ' Logstash modules support Netflow Version 5 and 9.' +
+      ' This modules support Netflow Version 5 and 9.' +


Minor typo: should be module (as opposed to modules).

alexfrancoeur · 2018-01-19T01:02:27Z

@gchaps I still can't get over the level of detail you put into this. From the UI's I've reviewed and the google doc, these changes look good to me. @makwarth can you take a look at the APM instructions and make sure you're ok with the changes?

makwarth · 2018-01-19T02:16:11Z

@alexfrancoeur Looks good - thanks @gchaps!

makwarth · 2018-01-19T02:19:40Z

Btw, if not too late, it'd be great to get this screenshot added to the APM header as part of this PR?

…This modules

alexfrancoeur · 2018-01-19T17:36:18Z

Closes #16003

* update short descriptions * apache log updates * apache metrics and and APM updates * docker, mysql, and kubernetes updates * netflow updates * all of the rest * remove From the installation directory, fix type Logstash modules => This modules * add APM dashboard screenshot * fix typo and download URL

* Tutorial copy (#16135) * update short descriptions * apache log updates * apache metrics and and APM updates * docker, mysql, and kubernetes updates * netflow updates * all of the rest * remove From the installation directory, fix type Logstash modules => This modules * add APM dashboard screenshot * fix typo and download URL * Adding "collects" to align with standard Netflow terminology of a collector

nreese added the :Sharing label Jan 18, 2018

nreese requested review from kobelb and ycombinator January 18, 2018 18:46

ycombinator reviewed Jan 18, 2018

View reviewed changes

kobelb approved these changes Jan 18, 2018

View reviewed changes

ycombinator reviewed Jan 18, 2018

View reviewed changes

nreese added 7 commits January 19, 2018 09:32

update short descriptions

7fb53ba

apache log updates

b895223

apache metrics and and APM updates

72e55d8

docker, mysql, and kubernetes updates

350b152

netflow updates

4756e97

all of the rest

8d90675

remove From the installation directory, fix type Logstash modules => …

b21ecaa

…This modules

nreese force-pushed the tutorial_copy branch from 2008276 to b21ecaa Compare January 19, 2018 16:33

nreese added 2 commits January 19, 2018 09:37

add APM dashboard screenshot

57b3f58

fix typo and download URL

49ce7d0

nreese merged commit 4c7ae2f into elastic:master Jan 19, 2018

nreese mentioned this pull request Jan 19, 2018

[6.x] Tutorial copy (#16135) #16164

Merged

nreese deleted the tutorial_copy branch February 13, 2018 19:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tutorial copy #16135

Tutorial copy #16135

nreese commented Jan 18, 2018

ycombinator Jan 18, 2018

ycombinator Jan 18, 2018 •

edited

Loading

ycombinator Jan 18, 2018

gchaps Jan 18, 2018

ycombinator Jan 18, 2018

gchaps Jan 18, 2018

ycombinator Jan 19, 2018

ycombinator Jan 18, 2018

gchaps Jan 18, 2018

kobelb left a comment

ycombinator Jan 18, 2018 •

edited

Loading

alexfrancoeur commented Jan 19, 2018

makwarth commented Jan 19, 2018

makwarth commented Jan 19, 2018

alexfrancoeur commented Jan 19, 2018

Tutorial copy #16135

Tutorial copy #16135

Conversation

nreese commented Jan 18, 2018

Choose a reason for hiding this comment

ycombinator Jan 18, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kobelb left a comment

Choose a reason for hiding this comment

ycombinator Jan 18, 2018 • edited Loading

Choose a reason for hiding this comment

alexfrancoeur commented Jan 19, 2018

makwarth commented Jan 19, 2018

makwarth commented Jan 19, 2018

alexfrancoeur commented Jan 19, 2018

ycombinator Jan 18, 2018 •

edited

Loading

ycombinator Jan 18, 2018 •

edited

Loading