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

cqliu1 · 2019-06-06T17:44:49Z

Summary

~~Blocked by #37614.~~ All changes from #37614 are reflected in this PR.

It's no longer useful to distinguish between common, client, and server from the user's standpoint since only server functions can run on the server while all other functions run on the client without any way of switching between the two.

I've combined all of the functions into a single list of all functions in Canvas.

This PR also covers changes to the function copy/i18n strings.

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
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

elasticmachine · 2019-06-06T17:55:23Z

Pinging @elastic/kibana-docs

elasticmachine · 2019-06-06T17:56:58Z

Pinging @elastic/kibana-canvas

ryankeairns

👍 LGTM. I like it!

KOTungseth

Commenting on the correct PR this time!

docs/canvas/canvas-function-reference.asciidoc

KOTungseth

Another batch of reviews.

docs/canvas/canvas-function-reference.asciidoc

clintandrewhall · 2019-06-13T02:14:50Z

How are we keeping this file in sync with the help strings we're using in the UI? Are we?

KOTungseth

This is the last of my initial edits. Let me know if you have any questions.

docs/canvas/canvas-function-reference.asciidoc

clintandrewhall

So many excellent changes here. Accepting to unblock, but please review my comments before committing.

clintandrewhall · 2019-07-06T16:19:09Z

src/legacy/core_plugins/interpreter/public/functions/font.ts

-            examples: Object.values(FontWeight).join(', '),
+            list: Object.values(FontWeight)
+              .slice(0, -1)
+              .map(weight => `\`"${weight}"\``)


nit: I would argue that " and code ticks are a bit redundant.

As a formatting decision, I chose to wrap any argument values in back ticks so this show up as inline code. Again related to other comment about markdown, it will render correctly in the docs when they're published, but they will look kinda funky in autocomplete until we can add support for markdown syntax, which I'm hoping I can tackle in the next release (I'm assuming it's a counts as a feature).

clintandrewhall · 2019-07-06T16:20:33Z

x-pack/legacy/plugins/canvas/canvas_plugin_src/functions/common/lt.ts

@@ -37,7 +37,6 @@ export function lt(): ExpressionFunction<'lt', Context, Arguments, boolean> {
        return false;
      }

-      // @ts-ignore #35433 This is a wonky comparison for nulls


Why was this removed?

#35433

Ah I fixed this in #37305, but I didn't realize there was an issue to close. My fault for skimming over the comment. I removed boolean and null as valid context types for gt, gte, lt, and lte. The comment was left behind, so I'm deleting it here, but the change to the function def was merged already.

clintandrewhall · 2019-07-06T16:23:32Z

x-pack/legacy/plugins/canvas/canvas_plugin_src/strings/functions/gte.ts

-    defaultMessage: 'Return if the context is greater than or equal to the argument',
+    defaultMessage: 'Returns whether the {context} is greater or equal to the argument.',
+    values: {
+      context: '_context_',


nit: are these underscores converted with markdown somehow? Or should there be code tick marks in the default message instead?

Currently autocomplete in Canvas doesn't support markdown, but I filed an issue a while back to add support for markdown rendering. #38439

This is the same syntax used in asciidoc, so it will show up as italicized in the published docs. For the sake of keeping all the content in sync including text formatting, I kept the syntax in even though you see the raw characters in the autocomplete.

x-pack/legacy/plugins/canvas/canvas_plugin_src/strings/functions/pie.ts

x-pack/legacy/plugins/canvas/canvas_plugin_src/strings/functions/repeatImage.ts

x-pack/legacy/plugins/canvas/canvas_plugin_src/strings/functions/seriesStyle.ts

…merge-canvas-fn-refs

elasticmachine · 2019-07-08T13:23:20Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-08T13:48:25Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-08T15:12:30Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

KOTungseth

LGTM!

elasticmachine · 2019-07-08T23:54:04Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-09T17:22:30Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-10T23:55:33Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-11T21:28:28Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

* 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

* [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)

* [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 force-pushed the docs/merge-canvas-fn-refs branch from d682b0b to b08691d Compare June 6, 2019 17:54

cqliu1 added Team:Docs impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort release_note:skip Skip the PR/issue when compiling release notes labels Jun 6, 2019

cqliu1 added v7.2.0 v7.3.0 v8.0.0 labels Jun 6, 2019

cqliu1 marked this pull request as ready for review June 6, 2019 17:56

cqliu1 added Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas review labels Jun 6, 2019

elastic deleted a comment from elasticmachine Jun 6, 2019

cqliu1 requested review from ryankeairns and gchaps June 6, 2019 19:13

ryankeairns approved these changes Jun 6, 2019

View reviewed changes

cqliu1 force-pushed the docs/merge-canvas-fn-refs branch from 2b8c14e to a9178a3 Compare June 6, 2019 19:25

cqliu1 requested a review from KOTungseth June 7, 2019 20:18

cqliu1 force-pushed the docs/merge-canvas-fn-refs branch from a9178a3 to 6eda8b5 Compare June 7, 2019 20:55

cqliu1 removed the v7.2.0 label Jun 7, 2019

KOTungseth reviewed Jun 11, 2019

View reviewed changes

cqliu1 force-pushed the docs/merge-canvas-fn-refs branch 2 times, most recently from 2ed90a1 to d5f1c39 Compare June 11, 2019 19:50

KOTungseth reviewed Jun 12, 2019

View reviewed changes

KOTungseth reviewed Jun 13, 2019

View reviewed changes

cqliu1 added impact:critical This issue should be addressed immediately due to a critical level of impact on the product. and removed impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort labels Jun 19, 2019

clintandrewhall approved these changes Jul 6, 2019

View reviewed changes

cqliu1 added 3 commits July 8, 2019 05:21

Addressing feedback

b1bd086

Merge branch 'master' of https://github.com/elastic/kibana into docs/…

ce68a14

…merge-canvas-fn-refs

Fixed jest test

d417779

Fixed missing import

b5d3ad9

KOTungseth approved these changes Jul 8, 2019

View reviewed changes

Fixed i18n error

6ce5e77

Restored metaFields arg in esdocs

3480d17

cqliu1 added 3 commits July 10, 2019 12:04

Merge branch 'master' into docs/merge-canvas-fn-refs

6fe1bd3

Extracted i18n string constants

30c6fa4

Fixed i18n errors

9c4920e

cqliu1 added 2 commits July 11, 2019 13:15

Updated translation files

b863a66

Merge branch 'master' into docs/merge-canvas-fn-refs

2bd9a96

cqliu1 mentioned this pull request Jul 11, 2019

[Canvas] Edit min/max values for axis in UI on point series chart #36693

Closed

cqliu1 merged commit 0166246 into elastic:master Jul 11, 2019

cqliu1 deleted the docs/merge-canvas-fn-refs branch July 11, 2019 21:48

cqliu1 mentioned this pull request Jul 11, 2019

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

Merged

This was referenced Jul 11, 2019

[Canvas][Docs] Fixes Canvas doc headers #40921

Merged

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

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

cqliu1 commented Jun 6, 2019 •

edited

Loading

elasticmachine commented Jun 6, 2019

elasticmachine commented Jun 6, 2019

ryankeairns left a comment

KOTungseth left a comment

KOTungseth left a comment

clintandrewhall commented Jun 13, 2019

KOTungseth left a comment

clintandrewhall left a comment

clintandrewhall Jul 6, 2019

cqliu1 Jul 8, 2019

clintandrewhall Jul 6, 2019

cqliu1 Jul 8, 2019

clintandrewhall Jul 6, 2019

cqliu1 Jul 8, 2019

elasticmachine commented Jul 8, 2019

elasticmachine commented Jul 8, 2019

elasticmachine commented Jul 8, 2019

KOTungseth left a comment

elasticmachine commented Jul 8, 2019

elasticmachine commented Jul 9, 2019

elasticmachine commented Jul 10, 2019

elasticmachine commented Jul 11, 2019

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

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

Conversation

cqliu1 commented Jun 6, 2019 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Jun 6, 2019

elasticmachine commented Jun 6, 2019

ryankeairns left a comment

Choose a reason for hiding this comment

KOTungseth left a comment

Choose a reason for hiding this comment

KOTungseth left a comment

Choose a reason for hiding this comment

clintandrewhall commented Jun 13, 2019

KOTungseth left a comment

Choose a reason for hiding this comment

clintandrewhall left a comment

Choose a reason for hiding this comment

clintandrewhall Jul 6, 2019

Choose a reason for hiding this comment

cqliu1 Jul 8, 2019

Choose a reason for hiding this comment

clintandrewhall Jul 6, 2019

Choose a reason for hiding this comment

cqliu1 Jul 8, 2019

Choose a reason for hiding this comment

clintandrewhall Jul 6, 2019

Choose a reason for hiding this comment

cqliu1 Jul 8, 2019

Choose a reason for hiding this comment

elasticmachine commented Jul 8, 2019

💔 Build Failed

elasticmachine commented Jul 8, 2019

💔 Build Failed

elasticmachine commented Jul 8, 2019

💔 Build Failed

KOTungseth left a comment

Choose a reason for hiding this comment

elasticmachine commented Jul 8, 2019

💔 Build Failed

elasticmachine commented Jul 9, 2019

💔 Build Failed

elasticmachine commented Jul 10, 2019

💔 Build Failed

elasticmachine commented Jul 11, 2019

💚 Build Succeeded

cqliu1 commented Jun 6, 2019 •

edited

Loading