-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[DOCS] Adds glossary to documentation #69721
Conversation
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Pinging @elastic/kibana-docs (Team:Docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
Co-authored-by: debadair <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added minor comments, otherwise LGTM
[[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, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought I saw in the style guide that we bold apps?
Apps include core {kib} components such as Discover and Dashboard, | |
Apps include core {kib} components such as *Discover* and *Dashboard*, |
docs/glossary.asciidoc
Outdated
<<glossary-advanced-settings,Advanced Settings>>. | ||
// end::lucene-def[] | ||
|
||
[[glossary-license-management]] License Management :: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
License Management
Does this component really need explanation? It seems quite straightforward.
docs/glossary.asciidoc
Outdated
For example, you might have different spaces for each team, use case, or individual. | ||
// end::space-def[] | ||
|
||
[[glossary-feature-space]] Spaces :: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The feature definitions are kind of awkward--it would be nice if it's possible to make this approach work.
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
Co-authored-by: Lisa Cawley <[email protected]>
docs/glossary.asciidoc
Outdated
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example here really helps.
|
||
|
||
[[glossary-TSVB-data]] TSVB :: | ||
// tag::TSVB-def[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// tag::TSVB-def[] | |
// tag::tsvb-def[] |
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[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
// 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]>
Friendly reminder: Looks like this PR hasn’t been backported yet. |
Friendly reminder: Looks like this PR hasn’t been backported yet. |
1 similar comment
Friendly reminder: Looks like this PR hasn’t been backported yet. |
Friendly reminder: Looks like this PR hasn’t been backported yet. |
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