Update "Debugging server code" instructions in CONTRIBUTING.md (#25397)

* Add more details for debugging Kibana server

* add debugging server code to table to contents
This commit is contained in:
Nathan Reese 2018-11-08 13:15:03 -07:00 committed by GitHub
parent 72ac1a9b8b
commit b9e258f766
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -22,6 +22,7 @@ A high level overview of our contributing guidelines.
- [Setting Up SSL](#setting-up-ssl) - [Setting Up SSL](#setting-up-ssl)
- [Linting](#linting) - [Linting](#linting)
- [Testing and Building](#testing-and-building) - [Testing and Building](#testing-and-building)
- [Debugging server code](#debugging-server-code)
- [Debugging Unit Tests](#debugging-unit-tests) - [Debugging Unit Tests](#debugging-unit-tests)
- [Unit Testing Plugins](#unit-testing-plugins) - [Unit Testing Plugins](#unit-testing-plugins)
- [Cross-browser compatibility](#cross-browser-compatibility) - [Cross-browser compatibility](#cross-browser-compatibility)
@ -281,7 +282,7 @@ macOS users on a machine with a discrete graphics card may see significant speed
- Restart iTerm - Restart iTerm
### Debugging Server Code ### Debugging Server Code
`yarn debug` will start the server with Node's inspect flag. Kibana's development mode will start three processes. Chrome's developer tools can be configured to connect to all three under the connection tab. `yarn debug` will start the server with Node's inspect flag. Kibana's development mode will start three processes on ports `9229`, `9230`, and `9231`. Chrome's developer tools need to be configured to connect to all three connections. Add `localhost:<port>` for each Kibana process in Chrome's developer tools connection tab.
### Unit testing frameworks ### Unit testing frameworks
Kibana is migrating unit testing from Mocha to Jest. Legacy unit tests still exist in Mocha but all new unit tests should be written in Jest. Kibana is migrating unit testing from Mocha to Jest. Legacy unit tests still exist in Mocha but all new unit tests should be written in Jest.