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.

Sign up for GitHub

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

Jump to bottom

[Canvas][Docs] Updates Canvas function reference #37614

Closed

cqliu1 wants to merge 3 commits into elastic:master from cqliu1:docs/canvas-functions

Contributor

cqliu1 commented May 31, 2019 •

edited

Loading

Summary

~~Blocked by #37305.~~
[skip-ci]

The Canvas function references have gotten out of sync with the codebase. I went through each function and updated the docs. I also made a few formatting changes. Changes made in #37305 are reflected in these doc changes.

Changes:

Moved argument aliases and default values onto a new line below the name and description, respectively
Wrapped function names, argument names, and data types/Canvas specific object names in backticks so they display in code blocks
Added a † marker to indicate an argument can be passed multiple times, which was missing from the docs previously
Added links to related functions for certain functions
Replace context type "Anything or nothing" with null and any
Added definitions for clear and progress
Removed definition for clog
Moved definitions for markdown, timelion and to to canvas-client-functions
Removed boolean and null as valid context types and boolean as valid value type for gt, gte, lt, and lte because they didn't make sense
Added missing args min, max, and tickSize in axisConfig definition
Added neq as valid op value in compare
Added filterGroup arg to dropdownControl, exactly, and timefilterControl

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~- [ ] This was checked for cross-browser compatibility, including a check against IE11~~

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
~~- [x] Documentation was added for features that require explanation or tutorials~~
~~- [ ] Unit or functional tests were updated or added to match the most common scenarios~~
~~- [ ] This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

cqliu1 added the Team:Presentation label

Contributor

elasticmachine commented May 31, 2019

Pinging @elastic/kibana-canvas

cqliu1 added loe:large impact:critical v7.2.0 v7.3.0 v8.0.0 release_note:plugin_api_changes release_note:skip WIP Team:Docs and removed release_note:plugin_api_changes labels

Contributor

elasticmachine commented May 31, 2019

Pinging @elastic/kibana-docs

cqliu1 mentioned this pull request

[Canvas] Clean up expression function definitions #37305

Merged

5 tasks

Contributor

elasticmachine commented May 31, 2019

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

kibanamachine mentioned this pull request

[Canvas] Canvas documentation #23109

Closed

21 tasks

ryankeairns approved these changes

View reviewed changes

Contributor

ryankeairns left a comment

👍 LGTM. I just skimmed the diff, but its obviously providing many corrections and additions. We can continue iterating on it and it feels like something we should push sooner rather than later.

cqliu1 removed the WIP label


          Synced up docs with function defs

4ff40bb

cqliu1 force-pushed the docs/canvas-functions branch from 17da51d to 4ff40bb Compare

June 4, 2019 22:41

cqliu1 added v7.2.0 and removed v7.2.0 labels

cqliu1 requested a review from gchaps

June 4, 2019 22:42

cqliu1 added the review label

cqliu1 marked this pull request as ready for review

June 4, 2019 22:43


          Updated docs with changes from PR elastic#37305

43eca25

cqliu1 mentioned this pull request

[Canvas][Docs] Merge Canvas function references #38300

Merged

4 tasks


          Fixed typo

3cd69a4

cqliu1 requested a review from KOTungseth

June 7, 2019 20:08

cqliu1 removed the v7.2.0 label

KOTungseth reviewed

View reviewed changes

Contributor

KOTungseth left a comment

My recommendations mostly include format changes, but let me know if you want to chat about any of these.

I'll review another chunk of this tomorrow.

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-common-functions.asciidoc


		Outputs the context to the console.
		Clears _context_ and returns `null`

Contributor

KOTungseth Jun 10, 2019

How about:

Clears the _context_, then returns null.

docs/canvas/canvas-common-functions.asciidoc

               [float]
-              === columns
+              [[columns_fn]]
+              === `columns`
               Includes or excludes columns from a data table. If you specify both, this will exclude first.

Contributor

KOTungseth Jun 10, 2019

How about:

Includes or excludes columns from a data table. TIP: When you specify both options, excludes the first option.

docs/canvas/canvas-common-functions.asciidoc

-              |include
-              |string
+              |`include`
+              |`string`
               |A comma separated list of column names to keep in the table

Contributor

KOTungseth Jun 10, 2019

This should be:

A comma-separated list of column names to include in the data table.

docs/canvas/canvas-common-functions.asciidoc

-              |exclude
-              |string
+              |`exclude`
+              |`string`
               |A comma separated list of column names to remove from the table

Contributor

KOTungseth Jun 10, 2019

This should be:

A comma-separated list of column names to remove from the data table.`

docs/canvas/canvas-common-functions.asciidoc

-              Compares the input to something else to determine true or false.
-              Usually used in combination with `if`. This only works with primitive types,
-              such as number, string, and boolean.
+              Compares the input to something else to determine `true` or `false`.

Contributor

KOTungseth Jun 10, 2019 •

edited by cqliu1

Loading

How about:

To determine true or false, compares the input. TIP: The compare function works only with primitive types, such as boolean, number, and string. Use compare with `<<if_fin>>. See also <<eq_fn>>, <<gt_fn>>, <<gte_fn>>, <<lt_fn>>, <<lte_fn>>, and <<neq_fn>>.

clintandrewhall reviewed

View reviewed changes

Contributor

clintandrewhall left a comment

Nit: let's also be consistent about ending all entries with periods, (or not)

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-client-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-server-functions.asciidoc

+              Alias: `type`
+              |`string`
+              |The name of the demo data set to use

Contributor

clintandrewhall Jun 13, 2019

I'd include a path to the demo data index file.

docs/canvas/canvas-server-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-server-functions.asciidoc Show resolved Hide resolved

docs/canvas/canvas-server-functions.asciidoc Show resolved Hide resolved

cqliu1 added a commit to cqliu1/kibana that referenced this pull request


          Added edits from PR elastic#37614

6898b44

Contributor Author

cqliu1 commented Jun 20, 2019

Closing this in favor of #38300. All changes made in this PR are reflected in #38300, and feedback provided here were added to #38300 in 6898b44.

cqliu1 closed this

cqliu1 added a commit to cqliu1/kibana that referenced this pull request


          [Canvas][Docs] Merge Canvas function references (elastic#38300)

31fa599

* Synced up docs with function defs

* Updated docs with changes from PR elastic#37305

* Merged canvas function ref into a single doc

* Fixed arg order

* Fixed typo

* Added alphabet links

* Added alphabet headers

* Removed B header

* Added missing args from

* Added edits from PR elastic#37614

* Updated containerStyle

* Removed metafields. ESSQL doesn't support retrieving metafields

* Edits to function copy

* More edits

* More edits

* Final round of edits

* Fixed i18n errors

* Addressing feedback

* Fixed jest test

* Fixed missing import

* Fixed i18n error

* Restored metaFields arg in esdocs

* Extracted i18n string constants

* Fixed i18n errors

* Updated translation files

cqliu1 added a commit that referenced this pull request


          [Canvas][Docs] Merge Canvas function references (#38300)

* Synced up docs with function defs

* Updated docs with changes from PR #37305

* Merged canvas function ref into a single doc

* Fixed arg order

* Fixed typo

* Added alphabet links

* Added alphabet headers

* Removed B header

* Added missing args from

* Added edits from PR #37614

* Updated containerStyle

* Removed metafields. ESSQL doesn't support retrieving metafields

* Edits to function copy

* More edits

* More edits

* Final round of edits

* Fixed i18n errors

* Addressing feedback

* Fixed jest test

* Fixed missing import

* Fixed i18n error

* Restored metaFields arg in esdocs

* Extracted i18n string constants

* Fixed i18n errors

* Updated translation files

cqliu1 added a commit to cqliu1/kibana that referenced this pull request


          [Canvas][Docs] Merge Canvas function references (elastic#38300)

c1c74a7

    * Synced up docs with function defs

    * Updated docs with changes from PR elastic#37305

    * Merged canvas function ref into a single doc

    * Fixed arg order

    * Fixed typo

    * Added alphabet links

    * Added alphabet headers

    * Removed B header

    * Added missing args from

    * Added edits from PR elastic#37614

    * Updated containerStyle

    * Removed metafields. ESSQL doesn't support retrieving metafields

    * Edits to function copy

    * More edits

    * More edits

    * Final round of edits

    * Fixed i18n errors

    * Addressing feedback

    * Fixed jest test

    * Fixed missing import

    * Fixed i18n error

    * Restored metaFields arg in esdocs

    * Extracted i18n string constants

    * Fixed i18n errors

    * Updated translation files

cqliu1 added a commit that referenced this pull request


          [7.x] [Canvas][Docs] Merge Canvas function references (#38300) (#40917)

5287d1e

* [Canvas][Docs] Merge Canvas function references (#38300)

* Synced up docs with function defs

* Updated docs with changes from PR #37305

* Merged canvas function ref into a single doc

* Fixed arg order

* Fixed typo

* Added alphabet links

* Added alphabet headers

* Removed B header

* Added missing args from

* Added edits from PR #37614

* Updated containerStyle

* Removed metafields. ESSQL doesn't support retrieving metafields

* Edits to function copy

* More edits

* More edits

* Final round of edits

* Fixed i18n errors

* Addressing feedback

* Fixed jest test

* Fixed missing import

* Fixed i18n error

* Restored metaFields arg in esdocs

* Extracted i18n string constants

* Fixed i18n errors

* Updated translation files

* Fixes Canvas doc headers (#40921)

cqliu1 added a commit that referenced this pull request


          [7.3] [Canvas][Docs] Merge Canvas function references (#38300) (#40923)

a6570c7

* [Canvas][Docs] Merge Canvas function references (#38300)

    * Synced up docs with function defs

    * Updated docs with changes from PR #37305

    * Merged canvas function ref into a single doc

    * Fixed arg order

    * Fixed typo

    * Added alphabet links

    * Added alphabet headers

    * Removed B header

    * Added missing args from

    * Added edits from PR #37614

    * Updated containerStyle

    * Removed metafields. ESSQL doesn't support retrieving metafields

    * Edits to function copy

    * More edits

    * More edits

    * Final round of edits

    * Fixed i18n errors

    * Addressing feedback

    * Fixed jest test

    * Fixed missing import

    * Fixed i18n error

    * Restored metaFields arg in esdocs

    * Extracted i18n string constants

    * Fixed i18n errors

    * Updated translation files

* Fixes Canvas doc headers (#40921)

* Fixed imports

cqliu1 deleted the docs/canvas-functions branch

April 27, 2020 18:40

KOTungseth mentioned this pull request

[DOCS] Update the Canvas function reference #98934

Closed

7 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

impact:critical loe:large release_note:skip review Team:Docs Team:Presentation v7.3.0 v8.0.0