Commit graph

160 commits

Author SHA1 Message Date
Stacey Gammon c9673e4153
Update doc slugs to improve analytic tracking, move to appropriate folders (#113630) (#113862)
* Update the slugs to improve google analytics drilldown tracking

* more slug updates

* Fix some formatting issues in building blocks

* update paths

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
# Conflicts:
#	dev_docs/key_concepts/persistable_state.mdx
#	legacy_rfcs/README.md
2021-10-04 20:43:23 -04:00
Kibana Machine ecd037e928
Point to new developer guide in CONTRIBUTING.md (#108953) (#108970)
* Point to new developer guide

* Update CONTRIBUTING.md

Co-authored-by: Stacey Gammon <gammon@elastic.co>
2021-08-17 14:42:05 -04:00
Stacey Gammon 7596ba4b38
Improvements to our developer guide (#67764) (#71455)
* contributing guide -> asciidoc

* Update docs/developer/contributing/index.asciidoc

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* Update docs/developer/best-practices/stability.asciidoc

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* Update docs/developer/contributing/index.asciidoc

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* address code review comments

* Update docs/developer/contributing/development-documentation.asciidoc

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>

* review comment updates

* fix bad ref

Co-authored-by: Peter Schretlen <peter.schretlen@gmail.com>
# Conflicts:
#	CONTRIBUTING.md
#	docs/developer/contributing/development-functional-tests.asciidoc
#	docs/developer/contributing/development-unit-tests.asciidoc
2020-07-13 12:16:18 -04:00
Spencer 104d4ea90a
[7.x] [kbn/optimizer] only build specified themes (#70389) (#70671)
Co-authored-by: spalger <spalger@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: cchaos <caroline.horn@elastic.co>
2020-07-02 20:34:17 -07:00
Kaarina Tungseth 6226aeac19
Updates the Release Notes content in CONTRIBUTING (#69032) (#69192)
* Updates the Release Notes content in CONTRIBUTING

* Release Notes guidelines

* Fixes bulleted list indentation
2020-06-15 14:47:18 -05:00
Eric Beahan b5af0f98a9
[7.x] Update table of contents to reflect current content (#66835) (#69025) 2020-06-12 10:20:20 -05:00
Kaarina Tungseth 4984bc6bbe
Updated the Writing documentation section in CONTRIBUTING.md (#68434) (#68664)
* Updated the Writing documentation section in CONTRIBUTING.md

* More changes
2020-06-09 15:22:27 -05:00
Vignesh Shanmugam d49eb7fd46
fix: rum agent should work correctly on new platform (#67037) (#67477)
* fix: rum agent should work correctly on new platform

* chore: add IS_KIBANA_DISTRIBUTABLE flag back

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-05-28 10:24:08 +02:00
Caroline Horn 72b60071e4
[Spaces] SASS modularization (#65921) (#66312)
* Removing Spaces legacy styles import in favor of direct plugin import

* Modularizing the `/management` components

* Further modularization within copy_saved_objects_to_space

* Add styling section to CONTRIBUTING

* SASS lint and snaps

* Adding link to EUI SASS
2020-05-13 09:46:03 -04:00
Ahmad Bamieh 40a5480021
[7.x] [i18n] add localization section in CONTRIBUTING file (#6… (#63934)
* add localization section

* upadte TOC

* Update CONTRIBUTING.md
2020-04-20 09:45:58 +03:00
Tiago Costa cff74466f7
docs(NA): add node-gyp setup instructions to the contributing guide. (#60116) (#60141) 2020-03-13 18:45:31 +00:00
Joe Reuter 88d21df047
fix outdated docs (#58729) (#59666) 2020-03-09 18:20:34 +01:00
Jonathan Budzenski a2716cc373
[7.x] Refactor test entry by runner (#44679) (#57930)
* Refactor test entry by runner (#44679)

Over the last few years we've increased the number of test runners.
Entry points by test type have become too lage of a category for unique
names, so this moves top level test scripts under yarn and replaces test
types with the runner name.

e.g. `yarn test:browser` -> `yarn test:karma`

Closes #41133

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* fix merge

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-02-21 10:43:49 -06:00
gchaps 52573c3097
[DOCS] Removes IRC from Contributing.md (#57397) (#57913)
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-02-18 13:14:39 -08:00
Michail Yasonik 850e520072
[7.x] Remove Kibana a11y guide in favor of EUI (#57021) (#57134)
* Remove Kibana a11y styleguide in favor of EUI and moving auxilary content to CONTRIBUTING.md and STYLEGUIDE.md

Co-Authored-By: Tim Roes <mail@timroes.de>
2020-02-07 14:45:01 -05:00
Mike Côté bb8b754f85
Update CONTRIBUTING.md --ssl documentation to mention it covers Elasticsearch as well (#55876) (#55901)
* Update CONTRIBUTING.md to mention --ssl flag works with Elasticsearch as well

* Change while to for
2020-01-27 08:10:18 -05:00
Tim Roes 36e2550101
Sync contribution guide with master (#54256) 2020-01-09 14:03:05 +01:00
Thomas Watson 55dbdb7887
Add example apm.dev.js config file to CONTRIBUTING.md (#52206) (#52292) 2019-12-05 19:06:40 +01:00
Thomas Watson c2fac8a7b5
Instrument Kibana with Elastic APM (#43548) (#52186)
Instruments Kibana with Elastic APM by adding the Node.js agent to the
source code. The agent is not turned on by default but can be enabled by
setting the environment variable `ELASTIC_APM_ACTIVE=true` or by
creating an apm config file called `config/apm.dev.js` and setting
`active: true` inside of it.

This implementation is not meant to be used by end-users of Kibana as it
lacks integration with the regular Kibana config file. For now, this is
meant as a useful internal tool for Elastic employees when developing
Kibana.

By default, it's pre-configured with a `serverUrl` pointing to an APM
Server hosted on Elastic Cloud. The data is stored in an ES cluster
accessible only by Elastic employees. These defaults can easily be
overwritten using environment variables or via the custom config file.
2019-12-04 17:04:12 +01:00
Thomas Watson 145f588ae9
docs: improve CONTRIBUTING docs for how to run Kibana tests (#51285) (#51437) 2019-11-22 16:46:42 +01:00
Alejandro Fernández Haro 6a27caf925
Better explanation about the Prettier recommendation (extension vs. NPM module) (#50629) (#50936)
* Better explanation about the Prettier recommendation (extension vs. NPM module)

* Contributing docs: Add side effect from using the Prettier extension
2019-11-18 18:36:27 +00:00
sainthkh 88a4db04b0 Adding "setting up prettier" in CONTRIBUTING.md (#46310)
Co-Authored-By: Jonathan Budzenski <jon@budzenski.me>
2019-10-14 11:02:44 -07:00
Spencer 33512feef8
[7.x] Only report the mocha tests once, as "Mocha tests" (#395… (#39582) 2019-06-25 09:02:30 -07:00
Tim Roes d3f4401b4c
Fix contribution guides release note process (#38965) (#38981) 2019-06-14 15:45:44 +02:00
Patrick Mueller 95c362805e
update CONTRIBUTING.md re: linting with VSCode (#37005) (#37675)
Adds a note in the Linting section about updating VSCode settings to
see "live" linting for TypeScript.
2019-05-31 12:34:00 -04:00
Va Da 8aa6fb52f8
Better scripted field editor (#36064) (#36340)
* fix: 🐛 make script input field full width

* test: 💍 update Jest snapshots

* feat: 🎸 add Groovy syntax highlighting

* test: 💍 update test snapshot

* test: 💍 fix scripted field form functional test

* test: 💍 fix more functional tests for scripted field input

* refactor: 💡 use import instead of require()
2019-05-09 13:12:22 +02:00
Rudolf Meijering cd519ca7fb
docs: Add test file location -> test runner table (#34986) (#35345)
* docs: Add test file location -> test runner table

* Use scripts/mocha instead of if yarn test:mocha and clarify arguments

* docs: add some examples of running tests suites with grep patterns

* Split out x-pack testing docs, add test runner column

* Split out x-pack testing docs, add test runner column #2

* Use node scripts for jest and split functional runner/server
2019-04-19 09:07:23 +02:00
Tyler Smalley b7113c02e4 [docs] Corrects breaking change issue label (#33252)
Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2019-03-14 09:19:52 -07:00
Aleh Zasypkin a8253de5b6
[7.x] Document scripts/i18n_check. (#32207) 2019-02-28 17:48:12 +02:00
Joe Reuter d97b169101
Fix i18n usage in flyout_session (#31577) (#31677) 2019-02-21 15:58:05 +01:00
Tiago Costa d5b2c8eaf2
Create vendor dll for the client modules (#22618)
* feat(NA): first dll bundler code.

* chore(NA): upgrade to webpack 4.

* chore(NA): updated package.json

* chore(NA): removed old code.

* chore(NA): add parallel option.

* chore(NA): removed console log and old var about  node modules.

* chore(NA): turn off unsafe cache.

* chore(NA): update lock files.

* chore(NA): new config for dll generation.

* chore(NA): update stats emit.

* chore(NA): update dependencies.

* chore(NA): right cache loaders.

* chore(NA): remove ui_bundles alias.

* feat(20749): init implementation on bridge plugin for dll bundler.

* feat(20749): init implementation for dll compiler.

* feat(20749): dll bundler init from other process and webpack wrapper..

* feat(20749): optimizer changes to integrate with  dll bundler.

* chore(20749): split into different processes.

* refact(20749): change to single running process.

* refact(NA): improvements on dll bundler plugin.

* refact(NA): removing including loop on plugins.

* refact(20749): only run dllReference once.

* chore(20749): todo on result.request path building.

* chore(NA): lock files updated.

* chore(NA): avoiding dll paths being removed.

* chore(NA): tests on sync generation.

* chore(NA): changes on entry paths compiler.

* chore(NA): different hooks tests.

* chore(20749): first working version, single process, for dynamic building dll.

* feat(20749): last gross features for the dynamicdllplugin.

* refact(20749): string interpolation when creating the path to delete in every optimizer cycle. feat(20749): creating the DynamicDllPlugin foundations.

* chore(NA): updated base optimizer run function args.

* chore(20749): first working solution with vendor dll both for prod and dev.

* chore(20749): useful todos on client dlls.

* feat(NA): auto built blacklist for server node_modules.

* refact(NA): removed unused code.

* chore(NA): update all webpack and loaders stuff to last versions.

* refact(NA): first refacts on clean taks related with dll. feat(NA): added clean empty folders task.

* refact(NA): removed support for console logs during the build.

* refact(NA): removed extra space.

* refact(NA): removed extra space.

* refact(NA): getDllModules function.

* chore(NA): removed unsafeCache option.

* feat(NA): removed unsafeCache option.

* refact(NA): apply general inheritance principles to the optimizer: hooks, and init. refact(NA): merge dynamic dll plugin into the common config. refact(NA): restore old template structure - vendors.dll style is always emitted.

* fix(NA): fs_optimizer run function by not returning inside async func.

* fix(NA): change template anchor name from vendor to vendors.

* docs(NA): added info about files were keeping when cleaning the bundles.

* fix(NA): filtering elible dll modules to delete.

* refact(NA): removed old dll bundler in favor on new dynamic dll plugin.

* refact(NA): initial split for clean modules on dll task.

* refact(NA): update new dll config model. refact(NA): update config on dynamicdllplugin.

* refact(NA): major work refactor for dynamic dll plugin.

* refact(NA): extract clean node modules on dll task to its own folder.

* refact(NA): organize imports.

* docs(NA): add docs to registerCompilerHooks function for the optimizer.

* refact(NA): finished refactor for dynamic dll plugin with correct error handling for runWebpack function.

* refact(NA): basic structure for clean client modules on dll task.

* fix(NA): resolve path for dll manifest during cclean build tasks.

* refact(NA): split webpack dll related functions to their own file for clean client modules on dll task.

* refact(NA): added error handling for the clean client modules on dll task - webpack dll related functions.

* docs(NA): added license header.

* refact(NA): complete split out the functions from the clean modules on dll task to the code_parser file.

* refact(NA): main task entries compose.

* docs(NA): extend docs for the getDependenciesFromFile function.

* refact(NA): final structure split for clean client node modules dll task.

* fix(NA): added missing param to calculate top level dependencies.

* docs(NA): completed todo description about dll location.

* fix(NA): add production option to webpack config on kbn-pm.

* docs(NA): extended documentation about style extraction.

* refact(NA): removed extra comments.

* feat(NA): env variable to force dll creation.

* feat(NA): include option to define folders to keep on delete empty folders task.

* refact(NA): remove unused method from dll compiler.

* feat(NA): move dlls outside bundles folder and support request for /dlls from a browser perspective.

* chore(NA): gitignore updated to include new dlls folder.

* chore(NA): eslintignore updated.

* chore(NA): removed strange file from repo.

* test(NA): fix failing tests for bundles_route.

* fix(NA): change paths array to path string in a server route config.

* fix(NA): remove infinite loop calls on register hooks functions.

* fix(NA): readFile should only override the file in case it not exists.

* refact(NA): removed dll compiler finish log on success with stats.

* fix(NA): dll compiler alias.

* fix(NA): dynamic dll plugin flow on needs compile.

* fix(NA): raw alias config.

* Revert "fix(NA): raw alias config."

This reverts commit ebb245a786.

* feat(NA): raw alias for moment on dll config model.

* fix(NA): removed uiBundles from base_optimizer call on dynamicdllplugin.

* chore(NA): decrease moment versions.

* chore(NA): temporary changes on dll compiler.

* fix(NA): majority of problems between dll approach, webpackshims and browser tests.

* fix(NA): webpackShims integration with client vendors dll. fix(NA): enable esm modules mutability for development. fix(NA): only clean dll contents from build when they belong to node_modules.

* fix(NA): fix for endless dll compilation loop.

* fix(NA): removed esm plugin and skipped test using wrong stub strategy.

* docs(NA): added some comments for the skipped test.

* feat(NA): considering requires inside webpackShims valid entry paths to add to the dll entry file.

* fix(NA): small fix for the max compilation logic.

* docs(NA): add small explanatory note.

* fix(NA): building requires results with relative requires found onn webpackShims.

* docs(NA): add small note for error handling on dll compiler.

* fix(NA): move precinct to prod dependencies.

* test(NA): testing running functional tests on production.

* fix(NA): restore tests run config for development flag. feat(NA): force dll creation with uiBundles is Dev flag.

* chore(NA): update dependencies.

* feat(NA): test update dll to completely match base optimizer one.

* fix(NA): removed ts.

* refact(NA): removed unused consts.

* fix(NA): set back transpile sacss task in place.

* fix(NA): fix resolve remoing ts and tsx.

* fix(NA): set back transpile sacss task in place.

* fix(NA): removing isDevmode from mustCompileDll.

* fix(NA): add search for import statements into the dependencies visitor.

* fix(NA): add dll suffix to vendors resource on ui bootstrap template.

* fix(NA): some configs for unrelated dll work projects.

* chore(NA): upgrade canvas plugins webpack build to webpack4.

* chore(NA): add shim for moment-duration-format.

* chore(NA): stup moment-duration-format into the moment webpackShim.

* chore(NA): setup moment-duration-format into the moment-timezone webpackShim.

* fix(NA): moment and moment-timezone webpackShims

* chore(NA): added moment and moment-timezone webpackShims to x-pack. fix(NA): revert changes on webpackShims for oss kibana.

* fix(NA): xpack webpackshims for moment.

* fix(NA): remove xpack webpakcshims for moment.

* fix(NA): webpakcshims for moment.

* fix(NA): remove every changes from webpackShims and xpack webpackShims.

* fix(NA): fix visitors to gather server dependencies resulting from export * from and export x, 'x' from.

* chore(NA): update some webpack related dependencies.

* fix(NA): in the dll the plugins need to have their own dependencies. It is the same for the ones into the tests relying on test against distributable.

* feat(NA): including test/plugin_functional plugins into the kbn-pm bootstrap tasks.

* fix(NA): wrong built yarn lock files.

* chore(NA): updated webpack related dependencies.

* feat(NA): add missing color for dynamic_dll_plugin logging tag.

* chore(NA): removed forgotten console.log.

* chore(NA): removed forgotten dead code.

* chore(NA): removed missing old comment.

* docs(NA): added missing notice for 2 tools we have relied on.

* refact(NA): added is to a boolean variable to keep the consistency inside the code parser strategies.

* fix(NA): update notice cli to exclude search inside dlls bundles. chore(NA): update notice file.

* feat(NA): use lodash matches in the code parser visitors logic.

* docs(NA): updated notice file related with the code parser visitors logic..

* docs(NA): added explanation for the process that decides if we should build a new dll or not.

* test(NA): added missing tests for some usefull parts of the code.

* refact(NA): split registerCompileHook function into small ones.

* chore(NA): uncomment scripts from tests.

* feat(NA): isolate code-parser in a kbn package

* fix(NA): missing relative dot into the cwd function.

* chore(NA): update all inter deps to match.

* fix(NA): rebuild the yarn locks and the package jsons based on master ones.

* fix(NA): move babel-code-parser to the prod deps.

* chore(NA): include build path instead of the base root path.

* refact(NA): integrate plugin_functional test plugins with workspaces.

* fix(NA): include missing license for plugin functional test plugins.

* fix(NA): always write posix paths into the dll entry file in order to make the dlls compilation working on windows too. chore(NA): improve error handling into dll compiler.

* fix(NA): revert wrong moved line from canvas.

* fix(NA): match ts-loader version between kibana and x-pack.

* fix(NA): sync dll compiler with base_optimizer.

* fix(NA): exclude kbn-interpreter from the dll.

* refact(NA): remove exclusion of kbn-interpretor from base_optimizer.

* chore(NA): add dlls folder to the yarn kbn clean script.

* fix(NA): missing utf8 input format encoding when reading a file to create the hash into the watch optimizer cahce.

* refact(NA): re-engineering to the dynamic_dll_plugin logs and lifecycle.

* fix(NA): update clean node modules task to search under legacy/core_plugins.

* fix(NA): fix build on windows with globby on cleaning dlls for the watch optimizer cache.

* docs(NA): update documentation for the clean client node modules build task.

* docs(NA): added extra comment to clarify the purpose for the built entrypoints.

* chore(NA): update clean client node_modules code to use posix path.

* feat(NA): add support for discovering server entries over the legacy plugins and the new plugins.
2018-12-05 15:45:19 +00:00
Nathan Reese b9e258f766
Update "Debugging server code" instructions in CONTRIBUTING.md (#25397)
* Add more details for debugging Kibana server

* add debugging server code to table to contents
2018-11-08 13:15:03 -07:00
dave.snider@gmail.com abb3fcf53e
[PROPOSAL] Make Kibana's PR template a checklist (#23511)
Kibana now uses a checklist for its PR template. The contributing docs were updated with more detail about release process.
2018-09-28 09:36:31 -07:00
Josh Dover 2351223b79
Add tip about iTerm 2 settings (#22502)
Changing this setting improved sped up unit tests by about 2x.
2018-08-30 12:33:28 -05:00
Josh Soref 2b27fb1c5f Fix misspellings (#19981) 2018-06-26 20:17:41 -07:00
Fabien Baligand 751b0c173d contrib docs : add a link to list all "build" options (#19464)
* contrib docs : add a link to list all "build" options

* list build options using "yarn build --help" command

* add bash code block

* remove space before ":"
2018-05-30 10:12:56 -05:00
Thomas Neirynck f3ea67e30f
Do not break on startup in debug mode (#19219)
Starting up the server in debug mode should not interrupt by default.
2018-05-18 15:15:05 -04:00
archana b58e757794
Functional test setup with kbn-test package (#18568)
Restructure testing with kbn-test package

 - Run with multiple configs, move cli options to config
 - Package-ify kbn-test
 - Eventually we'll have functional_test_runner live in a package
of its own, and then this kbn-test will use that as a dependency,
probably still as a devDependency.
 - Implement functional_tests_server
 - Collapse single and multiple config apis into one command

Use kbn-es

Replace es_test_cluster + es_test_config with kbn/test utils

Implement new createEsTestCluster

Improve scripts, jsdocs, cli top-level tools

Lift error handling to the top level
2018-05-09 18:23:49 -05:00
Justin Kambic 3eb559def5
Fix typo. (#18750) 2018-05-03 08:41:09 -04:00
Nathan Reese 9681fd4cf4
add jest instructions to CONTRIBUTING.md (#18620)
* add jest instructions to CONTRIBUTING.md

* remove package language and move x-pack jest instructions to x-pack/README.md
2018-05-02 13:57:10 -06:00
Hilko a2dae73efa HTTP for standard development URL in documentation (#17834)
The documentation states, that after using `yarn start` one should navigate to https://localhost:5601. For me it did not work, since kibana only seems to listen to https if one provides the "--ssl" flag as option (just as described in #### Setting Up SSL).
Thus, I changed the documentation to reflect this fact.
2018-04-30 10:41:29 -05:00
Tyler Smalley 5d8cf56532
[kbn-es] Use basic license as default (#18577)
Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2018-04-25 14:00:24 -07:00
Jenkins CI fe4609647d Migrate x-pack-kibana source to kibana 2018-04-24 13:48:10 -07:00
Court Ewing e0424608a6
docs: pull request review guidelines (#17101)
Outlines the general goals/philosophy behind our pull request review
process.
2018-04-19 12:36:37 -04:00
Anh Le 293fee9a59 Added Effective issue reporting in Kibana heading (#17424)
Added missing heading.
2018-03-28 14:27:02 +02:00
Tyler Smalley 82e17f435f
[kbn-es] Package for managing Elasticsearch during dev and testing (#17168)
Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>
2018-03-20 08:30:15 -07:00
Søren Louv-Jansen f47cac6427
Add .nvmrc file (#17145)
* Add .nvmrc file

* Update contributing docs

* Fix typo in `nvm use`

* Update "install node" text

* Add test to ensure .nvmrc and .node-version are identical

* Use async/await instead of promise

* Feedback
2018-03-15 14:34:31 +01:00
Spencer 4d246a10a8
[kbn-pm] rename from kbn-build (#16739) 2018-02-14 10:57:13 -07:00
Sherwin a75db2ff53 small gramatical fix in the 'CONTRBUTING.md' (#16659) 2018-02-12 11:40:29 +01:00
Kim Joar Bekkelund 08e48aa847
Kibana build tool (#15055)
* Introduce `kbn`, the Kibana build tool

* yarn kbn

* Make all deps devDeps

* Exclude __fixtures__ folder from Jest to avoid warnings

* Review fixes

* Update readme

* Use 'yarn kbn'

* Consistent rootPath

* Link to kbn tool

* Unsupported URL 'debug help' in contributing guide
2018-01-24 10:34:52 +01:00