Skip to content
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

[DOCS] Canvas docs 7.9 refresh #74000

Merged
merged 13 commits into from
Aug 12, 2020
Merged

[DOCS] Canvas docs 7.9 refresh #74000

merged 13 commits into from
Aug 12, 2020

Conversation

KOTungseth
Copy link
Contributor

@KOTungseth KOTungseth commented Jul 31, 2020 •
edited
Loading

Summary

This PR:

  • Adds the new variables content.
  • Reorganizes the Canvas docs.

Preview

https://kibana_74000.docs-preview.app.elstc.co/guide/en/kibana/master/canvas.html

Checklist

  • Documentation was added for features that require explanation or tutorials

@KOTungseth KOTungseth added Team:Docs Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas release_note:skip Skip the PR/issue when compiling release notes v7.10.0 7.9.0 labels Jul 31, 2020
@KOTungseth KOTungseth requested a review from poffdeluxe July 31, 2020 19:55
@KOTungseth KOTungseth self-assigned this Jul 31, 2020
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-canvas (Team:Canvas)

@jen-huang jen-huang added v7.9.0 and removed 7.9.0 labels Aug 3, 2020
@KOTungseth
Copy link
Contributor Author

@elasticmachine merge upstream

KOTungseth
KOTungseth commented Aug 4, 2020
View reviewed changes
docs/canvas/canvas-elements.asciidoc Outdated
[[create-canvas-element]]
==== Create an element
[[create-variables]]
=== Create variables
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Poff - Here are the docs for your new feature!

poffdeluxe
poffdeluxe reviewed Aug 4, 2020
View reviewed changes
docs/canvas/canvas-elements.asciidoc Outdated

* *{es} SQL* — Access your data in {es} using SQL syntax. For information about SQL syntax, refer to {ref}/sql-spec.html[SQL language].
Specify the variable syntax.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe this could be Specify the variable options ? I think of "variable syntax" being the expression syntax that gets copied to the clipboard

@KOTungseth KOTungseth requested a review from gchaps August 6, 2020 17:20
gchaps
gchaps reviewed Aug 10, 2020
View reviewed changes
docs/canvas/canvas-edit-workpads.asciidoc
[[change-the-element-settings]]
=== Change the element settings

Element settings enable you to change the display options at the element level. For example, use the element settings to change the dimensions, style, or location of an element.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you provide an example here?

docs/canvas/canvas-edit-workpads.asciidoc

[float]
[[edit-elements]]
==== Edit elements
Copy link
Contributor

Choose a reason for hiding this comment

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

Use a more specific title? Align, distribute, and reorder elements?

docs/canvas/canvas-present-workpad.asciidoc
@@ -1,6 +1,6 @@
[role="xpack"]
[[canvas-present-workpad]]
=== Present your workpad
== Present your workpad

When you are ready to present your workpad, use and enable the presentation options.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a little more explanation about what it means to "present your workpad."

docs/canvas/canvas-share-workpad.asciidoc Outdated Show resolved Hide resolved
docs/canvas/canvas-tutorial.asciidoc Show resolved Hide resolved
docs/user/canvas.asciidoc Outdated Show resolved Hide resolved
docs/user/canvas.asciidoc Outdated Show resolved Hide resolved
docs/user/canvas.asciidoc Outdated Show resolved Hide resolved
docs/user/canvas.asciidoc

To save a group of elements, press and hold Shift, select the elements you want to save, then click *Edit > Save as new element*.

Elements are saved in *Add element > My elements*.
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of "Elements are saved" how about "To view your saved elements, click ..."

docs/canvas/canvas-share-workpad.asciidoc Outdated Show resolved Hide resolved
@KOTungseth KOTungseth merged commit 8f54198 into elastic:master Aug 12, 2020
@KOTungseth KOTungseth deleted the docs/canvas-variables branch August 12, 2020 16:13
@KOTungseth KOTungseth mentioned this pull request Aug 12, 2020
Merged
KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Aug 12, 2020
@KOTungseth
[DOCS] Canvas docs 7.9 refresh (elastic#74000)
bbc26c1 
* [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>
# Conflicts:
#	docs/glossary.asciidoc
KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Aug 12, 2020
@KOTungseth
[DOCS] Canvas docs 7.9 refresh (elastic#74000)
cb334b5 
* [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>
# Conflicts:
#	docs/glossary.asciidoc
@KOTungseth KOTungseth mentioned this pull request Aug 12, 2020
Merged
KOTungseth added a commit that referenced this pull request Aug 12, 2020
@KOTungseth
[DOCS] Canvas docs 7.9 refresh (#74000) (#74880)
3e97d08 
* [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>
# Conflicts:
#	docs/glossary.asciidoc
KOTungseth added a commit that referenced this pull request Aug 12, 2020
@KOTungseth
[DOCS] Canvas docs 7.9 refresh (#74000) (#74878)
8180a38 
* [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>
# Conflicts:
#	docs/glossary.asciidoc
gmmorris added a commit to gmmorris/kibana that referenced this pull request Aug 13, 2020
@gmmorris
Merge branch 'master' into actions/webhook-remove-header
3557146 
* master: (28 commits)
  [Task manager] Prevents edge case where already running tasks are reschedule every polling interval (elastic#74606)
  [Security Solution] Fix the status of timelines' bulk actions (elastic#74560)
  Data plugin: Suggested enhance pattern (elastic#74505)
  Use jest.useFakeTimers instead of hard coded timeout for tooltip tests. (elastic#74642)
  [Security Solution][lists] Adds tests for exception lists and items part 2 (elastic#74815)
  [Security Solution][Resolver] fix presentation role on edgeline (elastic#74869)
  [Security Solution][Detections] Refactor ML calls for newest ML permissions (elastic#74582)
  [bin/kibana-plugin] support KP plugins instead (elastic#74604)
  Reduce number of indexed fields in index pattern saved object (elastic#74817)
  [reporting] Pass along generic parameters in high-order route handler (elastic#74892)
  Migrated last pieces of legacy fixture code (elastic#74470)
  Empty index patterns page re-design  (elastic#68819)
  [babel] coalese some versions to prevent breaking yarn install (elastic#74864)
  [Dashboard First] Decouple Attribute Service and By Value Embeddables (elastic#74302)
  Revert "[reporting] Pass along generic parameters in high-order route handler" (elastic#74891)
  [reporting] Pass along generic parameters in high-order route handler (elastic#74879)
  [src/dev/build] implement a getBuildNumber() mock (elastic#74881)
  [Enterprise Search] Add solution-level side navigation (elastic#74705)
  [DOCS] Canvas docs 7.9 refresh (elastic#74000)
  [Security Solution][Resolver]Enzyme test related events closing (elastic#74811)
  ...
gmmorris added a commit to gmmorris/kibana that referenced this pull request Aug 13, 2020
@gmmorris
Merge remote-tracking branch 'upstream/master' into task-manager/hand…
014d2f1 
…le-buffer-with-update-of-same-id

* upstream/master: (37 commits)
  [Task manager] Prevents edge case where already running tasks are reschedule every polling interval (elastic#74606)
  [Security Solution] Fix the status of timelines' bulk actions (elastic#74560)
  Data plugin: Suggested enhance pattern (elastic#74505)
  Use jest.useFakeTimers instead of hard coded timeout for tooltip tests. (elastic#74642)
  [Security Solution][lists] Adds tests for exception lists and items part 2 (elastic#74815)
  [Security Solution][Resolver] fix presentation role on edgeline (elastic#74869)
  [Security Solution][Detections] Refactor ML calls for newest ML permissions (elastic#74582)
  [bin/kibana-plugin] support KP plugins instead (elastic#74604)
  Reduce number of indexed fields in index pattern saved object (elastic#74817)
  [reporting] Pass along generic parameters in high-order route handler (elastic#74892)
  Migrated last pieces of legacy fixture code (elastic#74470)
  Empty index patterns page re-design  (elastic#68819)
  [babel] coalese some versions to prevent breaking yarn install (elastic#74864)
  [Dashboard First] Decouple Attribute Service and By Value Embeddables (elastic#74302)
  Revert "[reporting] Pass along generic parameters in high-order route handler" (elastic#74891)
  [reporting] Pass along generic parameters in high-order route handler (elastic#74879)
  [src/dev/build] implement a getBuildNumber() mock (elastic#74881)
  [Enterprise Search] Add solution-level side navigation (elastic#74705)
  [DOCS] Canvas docs 7.9 refresh (elastic#74000)
  [Security Solution][Resolver]Enzyme test related events closing (elastic#74811)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gchaps gchaps gchaps left review comments

@poffdeluxe poffdeluxe poffdeluxe approved these changes

Assignees

@KOTungseth KOTungseth

Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas v7.9.0 v7.10.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@KOTungseth @elasticmachine @poffdeluxe @gchaps @jen-huang