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.

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

Add top level examples folder and command to run, --run-examples. #52027

Merged

Conversation

stacey-gammon
Copy link
Contributor

@stacey-gammon stacey-gammon commented Dec 2, 2019

Fixes #26781

  • Adds a top level examples folder filled with example plugins that can be run with a --run-examples flag. Currently the only two plugins in there are:
    • Demo search - a plugin that registers a new custom search strategy
    • Search explorer - an app that shows/tests how both the demo search strategy, and the already registered es search strategy, can be used to search for data.
  • Creates a new functional test folder that has tests for the examples. I pulled this out from the plugin_functional folder so it could use the --run-examples flag in the config.

Blocks #52111

@elasticmachine
Copy link
Contributor

💔 Build Failed

@elasticmachine
Copy link
Contributor

💔 Build Failed

@stacey-gammon stacey-gammon force-pushed the 2019-11-25-run-demos-shortcuts branch 2 times, most recently from 4c31ad4 to c29adca Compare December 3, 2019 17:34
@elasticmachine
Copy link
Contributor

💔 Build Failed

@stacey-gammon stacey-gammon force-pushed the 2019-11-25-run-demos-shortcuts branch 2 times, most recently from d247678 to 4c199f0 Compare December 3, 2019 17:52
@stacey-gammon stacey-gammon added the release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. label Dec 3, 2019
@stacey-gammon stacey-gammon added v7.6.0 v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc and removed release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. labels Dec 3, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-platform (Team:Platform)

@elasticmachine
Copy link
Contributor

💔 Build Failed

@stacey-gammon stacey-gammon force-pushed the 2019-11-25-run-demos-shortcuts branch 2 times, most recently from fe4c89d to 96754d6 Compare December 3, 2019 18:11
@stacey-gammon stacey-gammon marked this pull request as ready for review December 3, 2019 18:34
@stacey-gammon stacey-gammon requested a review from a team as a code owner December 3, 2019 18:34
@elasticmachine
Copy link
Contributor

💔 Build Failed

@elasticmachine
Copy link
Contributor

💔 Build Failed

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@@ -237,7 +243,7 @@ export default function (program) {
silent: !!opts.silent,
watch: !!opts.watch,
repl: !!opts.repl,
basePath: !!opts.basePath,
basePath: opts.runExamples ? false : !!opts.basePath,
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the reason for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question. Added an explanation. Copying here:

          // We want to run without base path when the `--run-examples` flag is given so that we can use local
          // links in other documentation sources, like "View this tutorial [here](http://localhost:5601/app/tutorial/xyz)".
          // We can tell users they only have to run with `yarn start --run-examples` to get those
          // local links to work.  Similar to what we do for "View in Console" links in our
          // elastic.co links.

@stacey-gammon
Copy link
Contributor Author

@elasticmachine merge upstream

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

History

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

Copy link
Contributor

@tylersmalley tylersmalley left a comment

Choose a reason for hiding this comment

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

LGTM, tested

@stacey-gammon stacey-gammon merged commit 79fc07c into elastic:master Dec 10, 2019
jloleysens added a commit to jloleysens/kibana that referenced this pull request Dec 11, 2019
…le-sql-highlighting

* 'master' of github.com:elastic/kibana: (56 commits)
  Migrate url shortener service (elastic#50896)
  Re-enable datemath in from/to canvas timelion args (elastic#52159)
  [Logs + Metrics UI] Remove eslint exceptions (elastic#50979)
  [Logs + Metrics UI] Add missing headers in Logs & metrics (elastic#52405)
  [ML] API integration tests - initial tests for bucket span estimator (elastic#52636)
  [Watcher] New Platform (NP) Migration (elastic#50908)
  Decouple Authorization subsystem from Legacy API. (elastic#52638)
  [APM] Fix some warnings logged in APM tests (elastic#52487)
  [ui/public/utils] Delete unused base_object & find_by_param (elastic#52500)
  [ui/public/utils] Move items into ui/vis (elastic#52615)
  fix newlines in kbn-analytics build script
  Add top level examples folder and command to run, `--run-examples`. (elastic#52027)
  feat(NA): add trap for SIGINT in the git precommit hook (elastic#52662)
  [DOCS] Updtes description of elasticsearch.requestHeadersWhitelist (elastic#52675)
  [Telemetry/Pulse] Updates advanced settings text for usage data (elastic#52657)
  [SIEM][Detection Engine] Adds the default name space to the end of the signals index
  [Logs UI] Generalize ML module management (elastic#50662)
  Removing stateful saved object finder (elastic#52166)
  Shim oss telemetry (elastic#51168)
  [Reporting/Screenshots] Do not fail the report if request is aborted (elastic#52344)
  ...

# Conflicts:
#	src/legacy/core_plugins/console/public/legacy.ts
#	src/legacy/core_plugins/console/public/np_ready/application/models/legacy_core_editor/mode/elasticsearch_sql_highlight_rules.ts
#	src/legacy/core_plugins/console/public/np_ready/lib/autocomplete/components/full_request_component.ts
#	src/legacy/core_plugins/console/public/quarantined/src/sense_editor/row_parser.js
stacey-gammon added a commit to stacey-gammon/kibana that referenced this pull request Dec 11, 2019
…lastic#52027)

* Add top level examples folder and command to run, `--run-examples`.

* Add comment explaining reason --run-examples flag turns off base path.
stacey-gammon added a commit that referenced this pull request Dec 11, 2019
…52027) (#52739)

* Add top level examples folder and command to run, `--run-examples`.

* Add comment explaining reason --run-examples flag turns off base path.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes review Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v7.6.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Example plugins folder
4 participants