[DOCS] Adds glossary to documentation #69721

gchaps · 2020-06-23T17:42:40Z

Summary

This PR creates a glossary of terms for Kibana.

Preview
https://kibana_69721.docs-preview.app.elstc.co/guide/en/kibana/master/glossary.html

docs/glossary.asciidoc

Co-authored-by: Lisa Cawley <[email protected]>

elasticmachine · 2020-06-25T22:50:04Z

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

debadair

It will likely take some finessing once we start pulling the defs into the stack glossary, but this is awesome!

A number of these definitions seem to reflect our internal perspective more than a user's perspective. Many of my comments/suggestions are an attempt to turn that around, but I'm also lacking a lot of context, so take them with plenty of salt.

"Refer to" seems oddly formal. I'm used to seeing "See xyz" and "See also xyz" in glossaries. That's the pattern used in the Stack Glossary & I think we should be consistent.

docs/glossary.asciidoc

Co-authored-by: debadair <[email protected]>

lcawl

Added minor comments, otherwise LGTM

lcawl · 2020-06-26T15:42:21Z

docs/glossary.asciidoc

+[[glossary-app]] app ::
+// tag::app-def[]
+A top-level {kib} component that is accessed through the side navigation.
+Apps include core {kib} components such as Discover and Dashboard,


I thought I saw in the style guide that we bold apps?

Suggested change

Apps include core {kib} components such as Discover and Dashboard,

Apps include core {kib} components such as *Discover* and *Dashboard*,

docs/glossary.asciidoc

lcawl · 2020-06-26T15:56:54Z

docs/glossary.asciidoc

+<<glossary-advanced-settings,Advanced Settings>>.
+// end::lucene-def[]
+
+[[glossary-license-management]] License Management ::


License Management

Does this component really need explanation? It seems quite straightforward.

docs/glossary.asciidoc

lcawl · 2020-06-26T16:07:20Z

docs/glossary.asciidoc

+For example, you might have different spaces for each team, use case, or individual.
+// end::space-def[]
+
+[[glossary-feature-space]] Spaces ::


Spaces

In general I don't think we've defined all the "features" in the glossary. Given that you've defined "space", I question whether this entry is useful. If necessary, you can add the xpack-spaces.html link in the "space" definition.

The feature definitions are kind of awkward--it would be nice if it's possible to make this approach work.

docs/glossary.asciidoc

Co-authored-by: Lisa Cawley <[email protected]>

debadair · 2020-06-26T17:56:57Z

docs/glossary.asciidoc

-A custom navigation path between apps. Refer to {kibana-ref}/drilldowns.html[Drilldowns].
+A navigation path that retains context (time range and filters)
+from the source to the destination, so you can view the data from a new perspective.
+For example, a dashboard that shows the overall status of multiple data center


The example here really helps.

lcawl · 2020-06-26T21:21:25Z

docs/glossary.asciidoc

+
+
+[[glossary-TSVB-data]] TSVB ::
+// tag::TSVB-def[]


Suggested change

// tag::TSVB-def[]

// tag::tsvb-def[]

lcawl · 2020-06-26T21:21:36Z

docs/glossary.asciidoc

+A time series data visualizer that allows you to combine an
+infinite number of aggregations to display complex data.
+See {kibana-ref}/TSVB.html[TSVB].
+// end::TSVB-def[]


Suggested change

// end::TSVB-def[]

// end::tsvb-def[]

* master: [ML] Modifies page title to Create job (elastic#70191) [APM] Add API test for service maps (elastic#70185) [DOCS] Adds glossary to documentation (elastic#69721) [Usage Collection] Report nodes feature usage (elastic#70108) chore: improve support for mjs file extension (elastic#70186) [ML] Anomaly Detection: ensure 'Category examples' tab in the expanded table row can be seen (elastic#70241) [Maps] Add maps telemetry saved object in with mappings disabled (elastic#69995) Fix typo in bootstrap command (elastic#69976) [code coverage] ingest correct coveredFilePath for mocha (elastic#70215) [Dashboard] Add visualization by value to dashboard (elastic#69898) updates wording in Cases connectors (elastic#70298) [ML] Fix license subscription race condition. (elastic#70074) [Logs UI] [Alerting] "Group by" functionality (elastic#68250)

* [DOCS] Adds glossary to documentation * [DOCS] Fixes build errors * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * [DOCS] Adds more terms to glossary * [DOCS] Adds more terms to glossary * Update docs/glossary.asciidoc Co-authored-by: debadair <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: debadair <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: debadair <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: debadair <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: debadair <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: debadair <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: debadair <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: debadair <[email protected]> * [DOCS] Incorporates review comments * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * Update docs/glossary.asciidoc Co-authored-by: Lisa Cawley <[email protected]> * [DOCS] Incorporates review comments * [DOCS] Incorporates review comments Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: debadair <[email protected]>

kibanamachine · 2020-07-02T14:38:44Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 69721 or prevent reminders by adding the backport:skip label.

kibanamachine · 2020-07-03T14:48:44Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 69721 or prevent reminders by adding the backport:skip label.

kibanamachine · 2020-07-06T14:58:44Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 69721 or prevent reminders by adding the backport:skip label.

kibanamachine · 2020-07-07T15:08:45Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 69721 or prevent reminders by adding the backport:skip label.

[DOCS] Adds glossary to documentation

16a967b

gchaps added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes labels Jun 23, 2020

[DOCS] Fixes build errors

4cfacc6

lcawl mentioned this pull request Jun 24, 2020

Add kibana dependency to Glossary elastic/docs#1875

Merged

lcawl reviewed Jun 24, 2020

View reviewed changes

This was referenced Jun 24, 2020

[DOCS] Adds Kibana terms to glossary elastic/stack-docs#1213

Merged

Adds alphabetical links to Glossary elastic/stack-docs#1214

Merged

gchaps and others added 12 commits June 24, 2020 15:22

Update docs/glossary.asciidoc

8e328aa

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

e591a91

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

1ee1f4f

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

cadd787

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

6df1f39

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

bd4a9a4

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

3d3ea7b

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

489e998

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

7a06c22

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

6a8d3d9

Co-authored-by: Lisa Cawley <[email protected]>

[DOCS] Adds more terms to glossary

6f2e6fa

[DOCS] Adds more terms to glossary

843be4f

gchaps requested a review from debadair June 25, 2020 22:49

gchaps marked this pull request as ready for review June 25, 2020 22:50

debadair reviewed Jun 26, 2020

View reviewed changes

gchaps and others added 5 commits June 26, 2020 07:25

Update docs/glossary.asciidoc

3a25448

Co-authored-by: debadair <[email protected]>

Update docs/glossary.asciidoc

7391a3f

Co-authored-by: debadair <[email protected]>

Update docs/glossary.asciidoc

7b2d6a3

Co-authored-by: debadair <[email protected]>

Update docs/glossary.asciidoc

b0ca38b

Co-authored-by: debadair <[email protected]>

Update docs/glossary.asciidoc

a00a48a

Co-authored-by: debadair <[email protected]>

gchaps and others added 4 commits June 26, 2020 07:31

Update docs/glossary.asciidoc

65212de

Co-authored-by: debadair <[email protected]>

Update docs/glossary.asciidoc

6098db4

Co-authored-by: debadair <[email protected]>

Update docs/glossary.asciidoc

73ea951

Co-authored-by: debadair <[email protected]>

[DOCS] Incorporates review comments

654fbcd

lcawl approved these changes Jun 26, 2020

View reviewed changes

gchaps and others added 7 commits June 26, 2020 10:48

Update docs/glossary.asciidoc

bf1cbc6

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

545a35b

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

0b4400d

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

6deb3c9

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

e4f4502

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

52b77d4

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/glossary.asciidoc

7a133a0

Co-authored-by: Lisa Cawley <[email protected]>

debadair reviewed Jun 26, 2020

View reviewed changes

[DOCS] Incorporates review comments

6e5c9f4

lcawl reviewed Jun 26, 2020

View reviewed changes

docs/glossary.asciidoc

[[glossary-TSVB-data]] TSVB ::

// tag::TSVB-def[]

Copy link

Contributor

lcawl Jun 26, 2020

Choose a reason for hiding this comment

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

Suggested change

// tag::TSVB-def[]

// tag::tsvb-def[]

lcawl reviewed Jun 26, 2020

View reviewed changes

[DOCS] Incorporates review comments

9b10cab

gchaps merged commit 8978ec8 into elastic:master Jun 30, 2020

lcawl mentioned this pull request Jun 30, 2020

[DOCS] Fixes mismatched tagged region in glossary #70348

Merged

2 tasks

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jul 2, 2020

gchaps removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jul 6, 2020

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jul 7, 2020

lcawl added backport:skip This commit does not require backporting and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Jul 7, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Adds glossary to documentation #69721

[DOCS] Adds glossary to documentation #69721

gchaps commented Jun 23, 2020 •

edited

Loading

elasticmachine commented Jun 25, 2020

debadair left a comment

lcawl left a comment

lcawl Jun 26, 2020

lcawl Jun 26, 2020

lcawl Jun 26, 2020

debadair Jun 26, 2020

debadair Jun 26, 2020

lcawl Jun 26, 2020

lcawl Jun 26, 2020

kibanamachine commented Jul 2, 2020

kibanamachine commented Jul 3, 2020

kibanamachine commented Jul 6, 2020

kibanamachine commented Jul 7, 2020

	Apps include core {kib} components such as Discover and Dashboard,
	Apps include core {kib} components such as Discover and Dashboard,

[DOCS] Adds glossary to documentation #69721

[DOCS] Adds glossary to documentation #69721

Conversation

gchaps commented Jun 23, 2020 • edited Loading

Summary

elasticmachine commented Jun 25, 2020

debadair left a comment

Choose a reason for hiding this comment

lcawl left a comment

Choose a reason for hiding this comment

lcawl Jun 26, 2020

Choose a reason for hiding this comment

lcawl Jun 26, 2020

Choose a reason for hiding this comment

lcawl Jun 26, 2020

Choose a reason for hiding this comment

debadair Jun 26, 2020

Choose a reason for hiding this comment

debadair Jun 26, 2020

Choose a reason for hiding this comment

lcawl Jun 26, 2020

Choose a reason for hiding this comment

lcawl Jun 26, 2020

Choose a reason for hiding this comment

kibanamachine commented Jul 2, 2020

kibanamachine commented Jul 3, 2020

kibanamachine commented Jul 6, 2020

kibanamachine commented Jul 7, 2020

gchaps commented Jun 23, 2020 •

edited

Loading