Keoni edits to resource md changes 10 25 24 #123
Conversation
There was a problem hiding this comment.
The resources.md updates look to good to me, this seems like some helpful reorganization.
The debugging-harperdb.md simply does not belong in this repository, the document is for entirely different audience with an entirely different set of assumptions than HarperDB users.
If you want to add more information about debugging, I would add some information to the existing debugging.md documentation (is there an intuitive reason why users would expect to have look in two different debugging docs?), and describe when and how they should configure HarperDB to use port ranges (when you need to connect to different threads in devtools), and how debugging differs across different IDEs.
We can provide a link to Node.js's documentation for SSH tunneling which is much better for general purpose usage. The tips and performance profiling info could go in that document as well. This all should be in a separate PR.
|
|
||
| ## Port Configuration for Debugging | ||
|
|
||
| Since DevTools can only connect to one thread per port, we assign specific ports for debugging: |
There was a problem hiding this comment.
This is delivery specific, this is not the default config for HarperDB.
| When debugging a specific HarperDB instance, you’ll need to SSH into the instance using port tunneling. Here's how to connect to worker threads 1 and 2 (typically, debugging the main thread isn't needed since it doesn’t handle traffic): | ||
|
|
||
| ```bash | ||
| ssh -L 9230:localhost:9230 -L 9231:localhost:9231 [email protected] |
|
Also, for the resource.md documentation, a great follow-up would be to see if we could break it up into two documents. |
@kriszyp Please review my changes and let me know your thoughts