add new --run-examples flag #52031
Closed
add new --run-examples flag #52031
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stacey-gammon
added
chore
release_note:skip
|
Pinging @elastic/kibana-platform (Team:Platform) |
|
Pinging @elastic/kibana-operations (Team:Operations) |
stacey-gammon
commented
Dec 2, 2019
| @@ -237,7 +247,7 @@ export default function (program) { | |||
| silent: !!opts.silent, | |||
| watch: !!opts.watch, | |||
| repl: !!opts.repl, | |||
| basePath: !!opts.basePath, | |||
| basePath: opts.runExamples ? false : !!opts.basePath, | |||
There was a problem hiding this comment.
The reason to use no base path here is that we can use links into our examples in our api documentation, much like we have the View in Console links, that links to http://localhost:5601/kibana/demoSearch/.... We can link to these samples with a note that says, "be sure to running a local kibana with the --run-examples flag"
💚 Build Succeeded |
|
I was able to make faster progress on the bigger PR so this can be closed in favor of #52027 |
|
Closing in favor of #52027 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To test yarn
yarn start --run-examplesand see that the search explorer is available.Ideally I would switch the functional test running to use this flag, but I need to separate out the example plugins and the plugins that exist only for testing purposes. I started that effort here https://github.com/elastic/kibana/pull/52027/files but ran into issues with adding a new top level
examplesfolder with these plugins.So, that is the end goal, to have a top level examples folder that houses these plugins that are supposed to be more public (#26781) but that will involve a bit more effort, and so I can at least just make it easier to run these things, I pulled this little piece out.
Next steps, in parallel with that above effort, will be to add a new Embeddables example folder that is meant more for public consumption, is a new platform plugin, and add that. Then I would like to write a blog post, and be able to reference the command (
yarn start --run-examples) instead of showing the much longer--plugin-pathversion.