Vega doc changes by KOTungseth · Pull Request #63889 · elastic/kibana

KOTungseth · 2020-04-17T17:56:53Z

Summary

This PR:

Updates the first page of the Vega docs
Includes minor grammatical updates to the subsequent pages

Checklist

Documentation was added for features that require explanation or tutorials

elasticmachine · 2020-04-17T17:56:55Z

Pinging @elastic/kibana-docs (Team:Docs)

gchaps · 2020-04-17T19:25:28Z

docs/visualize/vega.asciidoc

-into Kibana, either standalone, or on top of a map.  To see Vega in action,
-watch this
-https://www.youtube.com/watch?v=lQGCipY3th8[short introduction video].
+experimental[] Build custom visualizations from multiple data sources using Vega


I recall a discussion where we prefer to use the banner on the first page of feature that is experimental and then use the inline tag for inner pages.

gchaps · 2020-04-17T19:27:12Z

docs/visualize/vega.asciidoc

+  data analysis. Compiles into Vega.

+For more information about Vega and Vega-Lite, refer to
+<<vega-useful-links, Useful links>>.


Suggest renaming this section Vega resources

gchaps · 2020-04-17T19:29:14Z

docs/visualize/vega.asciidoc

-`"url": "https://vega.github.io/editor/data/world-110m.json"`.
-See <<vega-using-vega-and-vegalite-examples, Vega and Vega-Lite examples>>.
-* For more information on getting started, check out this https://www.elastic.co/blog/getting-started-with-vega-visualizations-in-kibana[blog post].
+You create Vega visualizations by using the text editor. The text editor is


Is there a way to write this para without back-to-back "text editor"?

You create Vega visualizations by using the text editor, which is preconfigured with the options you need.

gchaps · 2020-04-17T19:37:19Z

docs/visualize/vega.asciidoc

-* Vega v4: `$schema: https://vega.github.io/schema/vega/v4.json`
+[float]
+[[vega-type]]
+==== Change the visualization type


This section was a little confusing. The two paragraphs are very similar.

The actions are similar, which is why the sections are similar.

gchaps · 2020-04-17T19:41:15Z

docs/visualize/vega.asciidoc

-can use embedded and external data with a `"url"` parameter. Kibana adds support for the direct Elasticsearch queries by overloading
+Vega https://vega.github.io/vega/docs/data/[data] elements
+use embedded and external data with a `"url"` parameter. {kib} adds support for
+the direct {es} queries by overloading


the direct > direct?

gchaps · 2020-04-17T19:55:07Z

docs/visualize/vega.asciidoc

+values, using `fit` model with zero padding.

 [[vega-debugging]]
 === Debugging


Debugging a Vega visualization?

gchaps · 2020-04-17T19:56:37Z

docs/visualize/vega.asciidoc


-If you are using Elasticsearch query, make sure your resulting data is
+If you are using an {es} query, make sure your resulting data is
 what you expected. The easiest way to view it is by using "networking"


networking > the networking

gchaps · 2020-04-17T19:57:54Z

docs/visualize/vega.asciidoc

 [[vega-notes]]
 [[vega-useful-links]]
-=== Useful Links
+=== Useful links


How about renaming as "Vega resources" or "Vega resources and examples"

Suggest also moving the Elastic blog posts above Vega-Lite resources.

gchaps · 2020-04-17T19:58:49Z

docs/visualize/vega.asciidoc

 ==== Additional configuration options

-These options are specific to the Kibana. link:#vega-with-a-map[Map support] has
+These options are specific to the {kb}. link:#vega-with-a-map[Map support] has


{kb} > {kib}

gchaps · 2020-04-17T20:01:04Z

docs/visualize/vega.asciidoc

+Since {kib} is unable to support dynamically loaded data, all data is fetched
+before it's passed to the Vega renderer.
+
+For example, count the number of documents in all indexes:


indexes > indices

gchaps

LGTM

* Vega doc changes * Final changes * Review comments

* master: (30 commits) Migrate vis_type_table to kibana/new platform (elastic#63105) Enable include/exclude in Terms agg for numeric fields (elastic#59425) follow conventions for saved object definitions (elastic#63571) [Docs]Adds saved object key setting to load balancing kib instances (elastic#63935) kbn/config-schema: Consider maybe properties as optional keys in ObjectType (elastic#63838) Fix page layouts, clean up unused code (elastic#63992) [SIEM] Adds recursive exact key checks for validation and formatter [Maps] Migrate remaining maps client files to NP (except routi… (elastic#63859) [Maps] Do not fetch geo_shape from docvalues (elastic#63997) Vega doc changes (elastic#63889) [Metrics UI] Reorganize file layout for Metrics UI (elastic#60049) Add sub-menus to Resolver node (for 75% zoom) (elastic#63476) [FTR] Add test suite metrics tracking/output (elastic#62515) [ML] Fixing single metric viewer page padding (elastic#63839) [Discover] Allow user to generate a report after saving a modified saved search (elastic#63623) [Reporting] Config flag to escape formula CSV values (elastic#63645) [Metrics UI] Remove remaining field filtering (elastic#63398) [Maps] fix date labels (elastic#63909) [TSVB] Use default Kibana palette for split series (elastic#62241) Ingest overview page (elastic#63214) ...

…t-node-pipelines * 'master' of github.com:elastic/kibana: (32 commits) Move authz lib out of snapshot restore (#63947) Migrate vis_type_table to kibana/new platform (#63105) Enable include/exclude in Terms agg for numeric fields (#59425) follow conventions for saved object definitions (#63571) [Docs]Adds saved object key setting to load balancing kib instances (#63935) kbn/config-schema: Consider maybe properties as optional keys in ObjectType (#63838) Fix page layouts, clean up unused code (#63992) [SIEM] Adds recursive exact key checks for validation and formatter [Maps] Migrate remaining maps client files to NP (except routi… (#63859) [Maps] Do not fetch geo_shape from docvalues (#63997) Vega doc changes (#63889) [Metrics UI] Reorganize file layout for Metrics UI (#60049) Add sub-menus to Resolver node (for 75% zoom) (#63476) [FTR] Add test suite metrics tracking/output (#62515) [ML] Fixing single metric viewer page padding (#63839) [Discover] Allow user to generate a report after saving a modified saved search (#63623) [Reporting] Config flag to escape formula CSV values (#63645) [Metrics UI] Remove remaining field filtering (#63398) [Maps] fix date labels (#63909) [TSVB] Use default Kibana palette for split series (#62241) ...

…bana into ingest-node-pipelines/privileges * 'feature/ingest-node-pipelines' of github.com:elastic/kibana: (34 commits) Move authz lib out of snapshot restore (elastic#63947) Migrate vis_type_table to kibana/new platform (elastic#63105) Enable include/exclude in Terms agg for numeric fields (elastic#59425) follow conventions for saved object definitions (elastic#63571) [Docs]Adds saved object key setting to load balancing kib instances (elastic#63935) kbn/config-schema: Consider maybe properties as optional keys in ObjectType (elastic#63838) Fix page layouts, clean up unused code (elastic#63992) [SIEM] Adds recursive exact key checks for validation and formatter [Maps] Migrate remaining maps client files to NP (except routi… (elastic#63859) [Maps] Do not fetch geo_shape from docvalues (elastic#63997) Vega doc changes (elastic#63889) [Metrics UI] Reorganize file layout for Metrics UI (elastic#60049) Add sub-menus to Resolver node (for 75% zoom) (elastic#63476) [FTR] Add test suite metrics tracking/output (elastic#62515) [Ingest pipelines] Delete pipeline (elastic#63635) [ML] Fixing single metric viewer page padding (elastic#63839) [Discover] Allow user to generate a report after saving a modified saved search (elastic#63623) [Reporting] Config flag to escape formula CSV values (elastic#63645) [Metrics UI] Remove remaining field filtering (elastic#63398) [Maps] fix date labels (elastic#63909) ... # Conflicts: # x-pack/legacy/plugins/uptime/public/components/monitor/ml/index.ts # x-pack/legacy/plugins/uptime/public/components/overview/index.ts # x-pack/plugins/ingest_pipelines/public/application/index.tsx # x-pack/plugins/ingest_pipelines/server/routes/api/index.ts # x-pack/plugins/ingest_pipelines/server/routes/index.ts

…bana into pipeline-editor-part-mvp-2 * 'feature/ingest-node-pipelines' of github.com:elastic/kibana: (34 commits) [Ingest Node Pipelines] Clone Pipeline (elastic#64049) Move authz lib out of snapshot restore (elastic#63947) Migrate vis_type_table to kibana/new platform (elastic#63105) Enable include/exclude in Terms agg for numeric fields (elastic#59425) follow conventions for saved object definitions (elastic#63571) [Docs]Adds saved object key setting to load balancing kib instances (elastic#63935) kbn/config-schema: Consider maybe properties as optional keys in ObjectType (elastic#63838) Fix page layouts, clean up unused code (elastic#63992) [SIEM] Adds recursive exact key checks for validation and formatter [Maps] Migrate remaining maps client files to NP (except routi… (elastic#63859) [Maps] Do not fetch geo_shape from docvalues (elastic#63997) Vega doc changes (elastic#63889) [Metrics UI] Reorganize file layout for Metrics UI (elastic#60049) Add sub-menus to Resolver node (for 75% zoom) (elastic#63476) [FTR] Add test suite metrics tracking/output (elastic#62515) [Ingest pipelines] Delete pipeline (elastic#63635) [ML] Fixing single metric viewer page padding (elastic#63839) [Discover] Allow user to generate a report after saving a modified saved search (elastic#63623) [Reporting] Config flag to escape formula CSV values (elastic#63645) [Metrics UI] Remove remaining field filtering (elastic#63398) ...

KOTungseth added 3 commits April 15, 2020 11:20

Vega doc changes

2b29264

Merge branch 'master' into docs/vega-updates

6dfdd72

Final changes

770d275

KOTungseth added Team:Docs release_note:skip Skip the PR/issue when compiling release notes v7.7.0 labels Apr 17, 2020

KOTungseth requested a review from gchaps April 17, 2020 17:56

KOTungseth self-assigned this Apr 17, 2020

gchaps reviewed Apr 17, 2020

View reviewed changes

Review comments

2ab693a

gchaps approved these changes Apr 20, 2020

View reviewed changes

KOTungseth merged commit e302fd8 into elastic:master Apr 20, 2020

KOTungseth deleted the docs/vega-updates branch April 20, 2020 20:56

This was referenced Apr 20, 2020

[7.x] Vega doc changes (#63889) #64008

Merged

[7.7] Vega doc changes (#63889) #64009

Merged

KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Apr 20, 2020

Vega doc changes (elastic#63889)

5e47366

* Vega doc changes * Final changes * Review comments

KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Apr 20, 2020

Vega doc changes (elastic#63889)

9ce3590

* Vega doc changes * Final changes * Review comments

KOTungseth added a commit that referenced this pull request Apr 20, 2020

Vega doc changes (#63889) (#64008)

164c483

* Vega doc changes * Final changes * Review comments

KOTungseth added a commit that referenced this pull request Apr 20, 2020

Vega doc changes (#63889) (#64009)

7c6a081

* Vega doc changes * Final changes * Review comments

Conversation

KOTungseth commented Apr 17, 2020

Summary

Checklist

Uh oh!

elasticmachine commented Apr 17, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gchaps left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants