Skip to content

Conversation

@alisonelizabeth
Copy link
Contributor

Fixes #69253

The example .txt file was imported incorrectly.

Screen Shot 2020-07-08 at 8 59 11 PM

Release note

This fixes an issue in Dev Tools Console where the example shown in the "Help" panel was formatted incorrectly.

@alisonelizabeth alisonelizabeth added Feature:Console Dev Tools Console Feature release_note:fix v8.0.0 Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// v7.9.0 labels Jul 9, 2020
@alisonelizabeth alisonelizabeth requested a review from a team as a code owner July 9, 2020 01:24
@elasticmachine
Copy link
Contributor

Pinging @elastic/es-ui (Team:Elasticsearch UI)

Copy link
Contributor

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

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

Code LGTM, didn't test locally. WDYT of hardcoding the string in JS as a string literal to preserve whitespace? I think this would simplify things by removing the dependency on a webpack loader and removing a .txt file, which we don't use anywhere else AFAIK so it's a bit of an oddity. It would also prevent this bug from happening again.

Copy link
Contributor

@jloleysens jloleysens left a comment

Choose a reason for hiding this comment

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

@alisonelizabeth Thanks for fixing this! I wonder when this happened and if it has to do with the use of import. In that case this may have been introduced after the NP migration.

I see that pre NP migration it was imported without !!raw-loader! (https://github.com/elastic/kibana/blob/6.5/src/core_plugins/console/public/src/directives/sense_help_example.js). Not that it matters too much :)

I tend to agree with CJ that we can probably just keep this in a const helpText =. But will leave it up to you!

@alisonelizabeth
Copy link
Contributor Author

@cjcenizal great suggestion! I updated the PR with this change.

@alisonelizabeth
Copy link
Contributor Author

@elasticmachine merge upstream

@alisonelizabeth
Copy link
Contributor Author

@elasticmachine merge upstream

@alisonelizabeth
Copy link
Contributor Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Build metrics

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@alisonelizabeth alisonelizabeth merged commit 8a1d7d7 into elastic:master Jul 9, 2020
alisonelizabeth added a commit to alisonelizabeth/kibana that referenced this pull request Jul 9, 2020
# Conflicts:
#	src/plugins/console/public/application/constants/help_example.txt
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Feature:Console Dev Tools Console Feature release_note:fix Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// v7.9.0 v8.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Console tool's example query formatted incorrectly

5 participants