Catherine Liu
b5e8ab7e67
[Canvas] Update function reference docs ( #156409 )
...
## Summary
Closes #141526 .
This updates the function reference docs for Canvas expressions. The
main update here is the deprecation message added to `filters` function.
I'm also removing an expression example that doesn't work.
<img width="866" alt="Screenshot 2023-05-02 at 9 26 54 AM"
src="https://user-images.githubusercontent.com/1697105/235727031-8ece820e-3db5-42c7-ba11-e94d647a8b84.png ">
@KOTungseth These changes impact as early as v8.4. Should I backport all
the way back through 8.4?
### Checklist
Delete any items that are not applicable to this PR.
- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing ), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md )
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html )
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html )
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/ ))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/ ),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US ))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker )
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server ))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers )
### Risk Matrix
Delete this section if it is not applicable to this PR.
Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.
When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:
| Risk | Probability | Severity | Mitigation/Notes |
|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx ) |
### For maintainers
- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process )
---------
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2023-05-03 11:24:47 -07:00
Kaarina Tungseth
9a26af6fac
[DOCS] Adds the 8.6 Presentation docs ( #145474 )
...
## Summary
Adds the docs for the following:
- #141824
Doc preview:
https://kibana_145474.docs-preview.app.elstc.co/guide/en/kibana/master/get-started.html
- #142780
Doc preview:
https://kibana_145474.docs-preview.app.elstc.co/guide/en/kibana/master/add-controls.html
- #143762
Doc preview:
https://kibana_145474.docs-preview.app.elstc.co/guide/en/kibana/master/add-controls.html
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2022-11-28 11:20:38 -05:00
Kaarina Tungseth
ced8978e89
[DOCS] Updates quick start and presentation sections with sample data changes ( #138945 )
...
* [DOCS] Updates Quick start with sample data changes
* Updates dashboard and editors with sample data changes
* Review comments
2022-08-18 11:55:13 -05:00
Corey Robertson
933f43d166
[Canvas] Update canvas function docs to match in app and vice versa ( #125259 )
...
* Update canvas function docs to match in app and vice versa
* Update src/plugins/expressions/common/expression_functions/specs/math_column.ts
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
* Update src/plugins/expressions/common/expression_functions/specs/math_column.ts
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
* Fix translations
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-03-01 15:55:11 -05:00
Kaarina Tungseth
2517865a19
[DOCS] Updates Canvas with new toolbar ( #123418 )
...
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-01-26 10:40:36 -06:00
Michael Dokolin
6ae646722b
[Expressions] Add support of comments ( #122457 )
...
* Add comments support to the expressions grammar
* Add typings to the interpreter parser
* Add expressions comments highlighting
* Update canvas to preserve original expression formatting
* Update documentation to cover comments
2022-01-20 20:46:52 +01:00
Kaarina Tungseth
97b4ada296
[DOCS] Updates {data-source} in Canvas ( #121216 )
2021-12-14 15:04:21 -06:00
Kaarina Tungseth
1f138fa18f
[DOCS] Updates Canvas images for 7.14 ( #106424 )
...
* [DOCS] Updates Canvas images for 7.14
* Fixes refresh image size
2021-07-26 10:17:44 -05:00
Wylie Conlon
0ef3cbe6ed
[Expressions] Introduce createTable expression function, and use in Lens ( #103788 )
...
* [Expressions] Introduce createTable expression function, and use in Lens
* Fix test
* Fix code style
* Fix typo
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-07-08 10:01:50 -04:00
Kaarina Tungseth
524fe6dfe2
[DOCS] Updates to the Reporting docs ( #101326 )
...
* [DOCS] Updates to thee Reporting docs
* Adds the main sharing page
* Final changes
* Changed configuring-reporting link to secure-reporting
* Updates from meeting with Tim and Larry
* Moves reporting and sharing content above ML
* Update docs/setup/configuring-reporting.asciidoc
Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
* Review comments from Tim and Larry
* Fixes broken links
* Fixes redirect
* Fixes broken link from ES docs
* Adds metadata to changed pages
* Review comments
Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
2021-06-30 12:10:04 -05:00
Wylie Conlon
bdc87409ba
[Lens] Create mathColumn function to improve performance ( #101908 )
...
* [Lens] Create mathColumn function to improve performance
* Fix empty formula case
* Fix tinymath memoization
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-16 10:35:55 -04:00
Michael Dokolin
bde81c2090
[Expressions] Create expressions function to get UI settings ( #101317 )
2021-06-10 15:17:52 +02:00
Kaarina Tungseth
63a177e3fd
Adds canvas clog
function ( #96418 )
...
* Add canvas `clog` function in the doc
* Add basic example to the `clog` canvcas function
* clog canvas function: switch definition/purpose
Co-authored-by: Laurent HUET <laurent.huet@gmail.com>
2021-04-07 10:19:29 -05:00
Kaarina Tungseth
5de5f23fc3
Updated asset code for canvas-expression-lifecycle ( #96414 )
...
The demo code need the asset to be wrapped in "' and asset- to be appended onto the id.
Co-authored-by: Zachary E Baxter <zachary.baxter@elastic.co>
2021-04-07 10:16:39 -05:00
Kaarina Tungseth
378073c74a
[DOCS] Canvas updates for 7.12.0 ( #94325 )
...
* [DOCS] Canvas updates for 7.12.0
* Fixes Visualize Library title
2021-03-16 11:21:35 -05:00
Marco Liberati
019473948f
[Expressions] [Lens] Add id and copyMetaFrom arg to mapColumn fn + add configurable onError argument to math fn ( #90481 )
...
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-02-25 09:43:15 +01:00
Kaarina Tungseth
e980ee4740
[DOCS] Updates reporting and Canvas share options ( #92529 )
...
* [DOCS] Updates reporting and Canvas share options
* Update docs/canvas/canvas-share-workpad.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Resizes images and minor text edits
* Updates dashboard embed content
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-02-24 09:54:28 -06:00
Kaarina Tungseth
e3063f6934
[DOCS] Dashboard docs refresh for 7.11 ( #85342 )
...
* [DOCS] 7.11 Dashboard docs refresh
* [Lens] end to end guide
* Fixes to writer errors
* Fixes errors
* Fixes error
* errors
* small corrections in e2e
* Introduction, CSV download, and end-to-end guide
* End-to-end guide
* End-to-end guide and intro
* Fixes broken external links
* Update docs/user/dashboard/dashboard.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/user/dashboard/dashboard.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/user/dashboard/dashboard.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/user/dashboard/lens-end-to-end/lens-end-to-end.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/user/dashboard/lens-end-to-end/lens-end-to-end.asciidoc
Co-authored-by: Marta Bondyra <marta.bondyra@gmail.com>
* Update docs/user/dashboard/lens-end-to-end/lens-end-to-end.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/user/dashboard/lens-end-to-end/lens-end-to-end.asciidoc
Co-authored-by: Marta Bondyra <marta.bondyra@gmail.com>
* Review comments
* Review comments and Vega
* Vega tutorials
* Timelion changes
* Bug fixes and clean up
* Introduction
* Clean up
* Link fixes
* Broken links
* Fixes Timelion link
* Minor intro changes
* Fixes Timelion link
* Vega changes
* Add reference content, and move Lens docs to their own page
* Update from review
* Review comments
* Link fixes
* Clean up
Co-authored-by: Marta Bondyra <marta.bondyra@elastic.co>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
Co-authored-by: Marta Bondyra <marta.bondyra@gmail.com>
2021-01-19 17:05:08 -06:00
Poff Poffenberger
d28ae4291a
[Docs] Update Canvas reporting docs for new full page layout feature ( #86124 )
...
* Update Canvas and reporting doc for new full page layout
* Typo
2020-12-17 15:05:30 -06:00
Kaarina Tungseth
516d886c3e
Revert "[Docs] [Lens] End to end guide" ( #85339 )
2020-12-08 14:57:22 -06:00
KOTungseth
865824bb87
[DOCS] 7.11 Dashboard docs refresh
2020-12-03 16:52:20 -06:00
Kaarina Tungseth
c77619352b
[DOCS] 7.10 Core UI changes ( #80407 )
...
* [DOCS] 7.10 screenCore UI changes
* Kibana access options
* Removed Kibana from Set up Kibana
* Removed rogue symbols
* Update docs/spaces/index.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Update docs/management/managing-beats.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Review comments
* Update docs/user/introduction.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Review comments
* Changed menu to main menu
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2020-10-22 09:06:51 -05:00
Kaarina Tungseth
8bea1727e7
[DOCS] Canvas refresh for 7.10 ( #80017 )
2020-10-08 12:04:59 -05:00
ncheckin
37d49b0052
updated discover with alt text ( #77660 )
...
* Update context.asciidoc
* Update document-data.asciidoc
* Update field-filter.asciidoc
* Update search.asciidoc
* Update set-time-filter.asciidoc
* Update viewing-field-stats.asciidoc
* Update canvas-edit-workpads.asciidoc
* Update canvas-expression-lifecycle.asciidoc
* Update canvas-present-workpad.asciidoc
* Update canvas-share-workpad.asciidoc
* Update canvas-tutorial.asciidoc
* Update docs/canvas/canvas-share-workpad.asciidoc
* Update docs/canvas/canvas-share-workpad.asciidoc
* Update docs/canvas/canvas-tutorial.asciidoc
* Update docs/canvas/canvas-tutorial.asciidoc
* Update docs/canvas/canvas-tutorial.asciidoc
* Update docs/canvas/canvas-tutorial.asciidoc
* Update docs/discover/search.asciidoc
* Update docs/discover/set-time-filter.asciidoc
* Update docs/discover/viewing-field-stats.asciidoc
* Update docs/discover/field-filter.asciidoc
* Update docs/discover/document-data.asciidoc
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2020-09-28 10:53:38 -05:00
Kaarina Tungseth
c84532aade
[DOCS] Dashboard-first docs refresh ( #76194 )
...
* [DOCS] Dashboard-first refresh
* Fixes broken links and partinto error
* Fixes images in panel table
* Fixes broken links
* Fixes broken drilldowns link
* Fixes images and table
* Removed un needed files and added edit content
* Update docs/getting-started/tutorial-visualizing.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Review comments
* Review comments
* Removed blocks
* Typo fix
* Update docs/getting-started/tutorial-sample-data.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/getting-started/tutorial-discovering.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/getting-started/tutorial-sample-data.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/getting-started/tutorial-visualizing.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/user/dashboard/edit-dashboards.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/user/dashboard/dashboard.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/user/dashboard/dashboard.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Update docs/user/dashboard/aggregation-reference.asciidoc
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
* Review comments
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
2020-09-03 16:34:25 -05:00
Matthew Kime
f6aa798535
remove dupe tinymath section ( #76093 )
2020-09-01 15:50:29 -05:00
Catherine Liu
7c2eb85a7d
[Canvas][Docs] Adds var
and var_set
to expression function reference ( #74291 )
2020-08-24 15:55:53 -07:00
Catherine Liu
3256992b35
[Canvas] Adds function reference docs generator ( #49402 )
...
Co-authored-by: Corey Robertson <corey.robertson@elastic.co>
2020-08-24 14:28:50 -07:00
Kaarina Tungseth
8f54198434
[DOCS] Canvas docs 7.9 refresh ( #74000 )
...
* [DOCS] Canvas docs refresh
* Reformatting
* Image descriptions
* Adds workpad redirect
* Link fix pt 2
* Link fix part 3
* Link fix part 4
* Comments from Poff
* Corrected file name
* Review comment
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-08-12 11:13:04 -05:00
Kaarina Tungseth
a5bbbf96b5
[DOCS] Image cleanup ( #71258 )
...
* [DOCS] Image clean up
* Second half of images folder
* Fixes errors
2020-07-09 10:38:50 -05:00
Kaarina Tungseth
896b9cddbc
[DOCS] Updates for navigation redesign ( #68709 )
...
* [DOCS] Updates for navigation redesign
* Getting started
* Set up text
* Discover
* Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools
* Dev Tools, Stack Monitoring, Management
* Management
* Final changes
* [DOCS] Updates for navigation redesign
* [DOCS] Updates CCR monitoring screenshots
* updates SIEM screenshot and Cases overview text
* Added Brandon's APM image
* [DOCS] Refines CCR shard screenshot
* Removed merge conflict image file
Co-authored-by: lcawl <lcawley@elastic.co>
Co-authored-by: Ben Skelker <ben.skelker@elastic.co>
2020-06-12 09:39:36 -05:00
Kaarina Tungseth
ee323bd86e
[DOCS] Updates Canvas docs with new menus ( #66061 )
...
* [DOCS] Updates for Canvas menus
* Image set up
* Update docs/canvas/canvas-share-workpad.asciidoc
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
* Update docs/canvas/canvas-present-workpad.asciidoc
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
* Update docs/canvas/canvas-tutorial.asciidoc
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
* [DOCS] Adds Catherine's images and minor updates to content
* Final images and clean up
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
2020-06-03 14:28:33 -05:00
Kaarina Tungseth
0c259102ed
[DOCS] Removed saved object options ( #66072 )
...
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-05-11 15:42:56 -05:00
Catherine Liu
058044065c
[Canvas] Updates function reference docs ( #64741 )
2020-05-04 10:07:23 -07:00
Kaarina Tungseth
59c044ff00
[DOCS] Removed references to right ( #62508 )
2020-04-09 12:42:30 -05:00
Kaarina Tungseth
809ec97649
[DOCS] Removed references to left ( #60807 )
...
* [DOCS] Removed references to left
* Fixed broken build
2020-04-06 15:37:45 -05:00
Kaarina Tungseth
6af9b136bc
[DOCS] Changed Elasticsearch raw data ( #61997 )
...
* [DOCS] Changed Elasticsearch raw data
* Review comments
2020-03-31 13:13:41 -05:00
Kaarina Tungseth
9ec240a752
[DOCS] Canvas assets ( #57494 )
...
* [DOCS] Canvas assets
* Structure reorganization
* Separated out workpad content
* Images, content reorg
* Review comments
* Review comments
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-03-26 10:28:55 -05:00
Kaarina Tungseth
56006534af
[DOCS] Removed below references ( #60159 )
2020-03-16 09:58:16 -05:00
Kaarina Tungseth
84f6885c36
[DOCS] Removed spatial references ( #59595 )
...
* [DOCS] Removed ss above spatial references
* Removed above from n numeral formatting page
2020-03-09 10:29:25 -05:00
Wylie Conlon
07fec2f725
Documentation for numeral pattern formatting ( #57616 )
...
* Documentation for Elastic Numeral formatting
* Tweaks from feedback
* Updates from feedback
* Fix and update examples
* Add TODOs
* Fix typo
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-02-26 14:17:59 -05:00
Kaarina Tungseth
ba875c4e66
[DOCS] Canvas embed objects ( #57156 )
2020-02-10 11:05:01 -06:00
Peter Schretlen
2234210369
resolves #53038 - remove references to specific license levels ( #53858 )
2020-01-17 14:41:55 -05:00
Tim Schnell
71591632bd
[skip-ci] Expression Lifecycle Docs ( #51494 )
...
* adding context and arguments section
* Change Your Expression docs section for Canvas Expression docs
* typo or somethin
* Adding Expressions Only Fetch and Manipulate Data section
* Added argument sections of expression docs
* Add Composing Functions and Sub Expression docs
* adding shaun changes
* removing redundant lifecycle link
* PR edits
* fixing links
* more edits
* more edits from kaarina
* Update docs/canvas/canvas-expression-lifecycle.asciidoc
Co-Authored-By: Catherine Liu <catherineqliu@outlook.com>
* Update docs/canvas/canvas-expression-lifecycle.asciidoc
Co-Authored-By: Catherine Liu <catherineqliu@outlook.com>
* Update docs/canvas/canvas-expression-lifecycle.asciidoc
Co-Authored-By: Vadim Dalecky <streamich@users.noreply.github.com>
* more edits for images
* adding image showing no legend
* escaping underscore
* fixing underscore again
* fixing image name
* adjusting image height
Co-authored-by: Poff Poffenberger <poffdeluxe@gmail.com>
Co-authored-by: Catherine Liu <catherineqliu@outlook.com>
Co-authored-by: Corey Robertson <crob611@gmail.com>
Co-authored-by: Vadim Dalecky <streamich@users.noreply.github.com>
2020-01-02 15:18:17 -06:00
Kaarina Tungseth
98ec7a3470
[DOCS] Canvas data sources ( #53334 )
...
* [DOCS] Canvas data sources
* Comments from Gail
2019-12-19 14:56:30 -06:00
Catherine Liu
bcd0c09899
[Canvas][Docs] Updates function reference ( #50393 )
...
* Updates Canvas function reference doc
* Added context examples
* Addressed feedback
* escapes curly braces
* Updated location help text
* Fixes doc build error
2019-11-22 16:05:09 -07:00
Kaarina Tungseth
d04d5e9eef
[DOCS] Shareables naming convention ( #50497 )
...
* [DOCS] Shareables
* Updated topic titile
2019-11-18 12:36:11 -06:00
Kaarina Tungseth
ded8950559
[DOCS] Canvas embeddable workpads ( #45027 )
...
* [DOCS] New Canvas snapshots documentation
* Changes from 1-Oct meeting
* Some tweaks
* Added beta tag
* Fixes to images
* Comments from Gail and Tim
* New images
* Final changes
2019-10-31 10:45:43 -05:00
Catherine Liu
9482ba5765
Fixed typo in formatnumber example ( #49379 )
2019-10-26 06:25:09 -07:00
Tim Schnell
a4d2638d48
[skip ci] Function Reference Docs Update ( #48791 )
...
* setting up function reference pattern
* adding functions A-F
* grammar fixes
* Apply suggestions from code review
Co-Authored-By: Catherine Liu <catherineqliu@outlook.com>
* more review updates
2019-10-25 12:27:11 -05:00