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

[Vega][Inspect panel] Write tutorials and reference #73262

Merged
merged 19 commits into from
Jul 30, 2020

Conversation

alexwizp
Copy link
Contributor

Summary

Add docs related to the Inspect Panel for Vega visualization

Checklist

Delete any items that are not applicable to this PR.

For maintainers

@timroes timroes mentioned this pull request Jul 27, 2020
20 tasks
@alexwizp alexwizp self-assigned this Jul 27, 2020
@alexwizp alexwizp added Feature:Vega Vega visualizations docs release_note:skip Skip the PR/issue when compiling release notes Team:Visualizations Visualization editors, elastic-charts and infrastructure labels Jul 27, 2020
@alexwizp alexwizp marked this pull request as ready for review July 27, 2020 13:42
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app (Team:KibanaApp)

@timroes
Copy link
Contributor

timroes commented Jul 27, 2020

Small note here: we're trying to crop screenshots as much as possible to the content we want to show (since that ease and lowers requirement for further updating them). Do you think we could make screenshots that'll only contain the inspector panel instead of the visualization behind (and part of the Kibana UI frame).

@alexwizp
Copy link
Contributor Author

@elasticmachine merge upstream

@alexwizp
Copy link
Contributor Author

@elasticmachine merge upstream

Copy link
Contributor

@KOTungseth KOTungseth left a comment

Choose a reason for hiding this comment

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

This looks great! I added some suggestions, but otherwise, LGTM!

@@ -1505,6 +1505,47 @@ Vega can load data from any URL, but this is disabled by default in {kib}.
To change this, set `vis_type_vega.enableExternalUrls: true` in `kibana.yml`,
then restart {kib}.

[[vega-inspector]]
==== Vega Inspector
Copy link
Contributor

Choose a reason for hiding this comment

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

Can this be an actionable title? Something like Inspect Vega visualizations?

docs/visualize/vega.asciidoc Outdated Show resolved Hide resolved
docs/visualize/vega.asciidoc Outdated Show resolved Hide resolved
docs/visualize/vega.asciidoc Outdated Show resolved Hide resolved
docs/visualize/vega.asciidoc Outdated Show resolved Hide resolved
===== Asking for help with a Vega spec

Because of the dynamic nature of the data in {es}, it is hard to help you with
Vega specs unless you can share a dataset. To do this, open the *Inspector > Vega debug* view
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Vega specs unless you can share a dataset. To do this, open the *Inspector > Vega debug* view
Vega specs unless you can share a data set. To do this, open the *Inspector > Vega debug* view

docs/visualize/vega.asciidoc Outdated Show resolved Hide resolved
docs/visualize/vega.asciidoc Outdated Show resolved Hide resolved
docs/visualize/vega.asciidoc Outdated Show resolved Hide resolved
docs/visualize/vega.asciidoc Outdated Show resolved Hide resolved
alexwizp and others added 9 commits July 29, 2020 22:20
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
alexwizp and others added 6 commits July 29, 2020 22:22
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
@alexwizp alexwizp merged commit 774c4f4 into elastic:master Jul 30, 2020
alexwizp added a commit to alexwizp/kibana that referenced this pull request Jul 30, 2020
* [Vega][Inspect panel] Write tutorials and reference

* update screens

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
alexwizp added a commit that referenced this pull request Jul 30, 2020
* [Vega][Inspect panel] Write tutorials and reference

* update screens

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/visualize/vega.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jul 30, 2020
* master:
  [Vega][Inspector] Request panel should show correct names for requests (elastic#73655)
  [Security Solution] Update filter (elastic#73350)
  TSVB Inaccurate Group By (elastic#73683)
  [Vega][Inspect panel] Write tutorials and reference (elastic#73262)
  [ML] Removing node info check for file data viz import (elastic#73717)
  check that pathname has been updated. ignore other parts (elastic#73689)
  [build] rewrite source as transpiled JS later in the process (elastic#73749)
  Fix Snapshot Restore /policies/indices API endpoint on Cloud (elastic#73734)
  skip flaky suite (elastic#69783) (elastic#70043)
  [Security Solution][Exceptions] - Updates exception hooks and viewer (elastic#73588)
  skip failing suite (elastic#58815)
  [Canvas][fatal bug] Fix props confusion in TextStylePicker (elastic#73732)
  [DOCS] Changes level offset of monitoring pages (elastic#73573)
  Added close button to toast notifications by migrating to different API that is more widely used in Kibana and Security solution in particular. (elastic#73662)
  [ML] Transforms/DFA: Change action button size back to 'xs'.
  [Metrics UI] Fix evaluating rate-aggregated alerts when there's no normalized value (elastic#73545)
  [Metrics UI] Fix formatting of values in inventory context.reason (elastic#73155)
  [maps] rename GisMap to MapContainer and convert to TS (elastic#73690)
  [APM] docs: remove watcher documentation  (elastic#73485)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Feature:Vega Vega visualizations release_note:skip Skip the PR/issue when compiling release notes Team:Visualizations Visualization editors, elastic-charts and infrastructure v7.10.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants