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

Add Data UI Text Review #16003

Closed
alexfrancoeur opened this issue Jan 11, 2018 · 4 comments
Closed

Add Data UI Text Review #16003

alexfrancoeur opened this issue Jan 11, 2018 · 4 comments
Labels
Feature:Add Data Add Data and sample data feature on Home Team:Visualizations Visualization editors, elastic-charts and infrastructure

Comments

@alexfrancoeur
Copy link

Now that the Add Data UI is merged (#14749) @gchaps will be taking a pass at the tutorial text to make sure the instructions are easy to follow. We'll use this issue to track any text descriptions, format and syntax changes that may be required.

cc: @tsg, @nreese, @jsvd, @ycombinator

@gchaps
Copy link
Contributor

gchaps commented Jan 12, 2018

Here are some changes to improve the text on the Home page:

  1. Change this intro sentence:

These turnkey solutions will help you quickly add data into Kibana and turn it into pre-built dashboards and monitoring systems.

to:

Use these solutions to quickly turn your data into pre-built dashboards and monitoring systems.

  1. Make the "Add data" button in the Logging, Metrics, and Security cards more specific

Add log data
Add metric data
Add security events

@gchaps
Copy link
Contributor

gchaps commented Jan 18, 2018

Comments on the Add Data tutorials:

Overall

  • Links to documentation should open in a separate tab
  • Add Data Home page needs edits for consistency
  • Suggested improvements to intro paragraphs
  • “Learn more about the xxxx module” can be simplified to “Learn more.”
  • APM has a typo and missing ending punctuation
  • MySQL Metrics is not consistent with other tutorials. Made suggestions for improvements
  • “View exported fields” button is confusing. I expected it to navigate within the UI and not go to the documentation. Maybe because its so close to the Learn more, which is a link. Could both be links: Learn more about the module | View exported fields
  • Once all steps are completed, you’re ready to explore your data.” reads better as “Once you complete all steps, you’re ready to explore your data.” Also, its missing ending punctuation

Smaller tweaks

  • Type in code block was sometimes red when it should be black
  • 32 bits package -> 32-bit package
  • In Overview >> Endpoints note Elasticsearch as <es_url> is better as: Overview > Endpoints, note Elasticsearch as <es_url>. (One > and command after Endpoints)

The Google doc list edits per tutorial page.

@alexfrancoeur
Copy link
Author

Thanks @gchaps, I appreciate the quick response / review 😄 I'll work with @nreese on your feedback

@alexfrancoeur alexfrancoeur added the Feature:Add Data Add Data and sample data feature on Home label Feb 2, 2018
@alexfrancoeur
Copy link
Author

All set, closing this out.

@timroes timroes added Team:Visualizations Visualization editors, elastic-charts and infrastructure and removed :Sharing labels Sep 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Add Data Add Data and sample data feature on Home Team:Visualizations Visualization editors, elastic-charts and infrastructure
Projects
None yet
Development

No branches or pull requests

3 participants