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
architecture documentation #1452
Conversation
docs/architecture.md
Outdated
|
||
Puma is a threaded web server, processing requests across a TCP or UNIX socket. | ||
|
||
Workers accept connections from the socket and a thread in the worker pool processes the client's request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"worker pool" -> "worker's thread pool"
One quick change there, but otherwise LGTM and thank you so much for this! |
4cad6b4
to
1bc40ad
Compare
@nateberkopec fixed, thanks. |
@eprothro Remind me: what did you use to make these diagrams? |
@nateberkopec In this case I used draw.io, saved the pngs in the repo, and used a shortened link to a url that embeds the diagram content/source. You can click the diagram links from the MD file, click edit, and then make whatever changes are needed. Draw.io now supports embedding the diagram in the png, so now I usually save diagram pngs (with embedded diagrams in them) in-repo, and future contributors have everything they need without the shortened URL... |
@eprothro nice man, thanks! |
Cool. Thanks for the link. Exports svg also, which might be a better format for 'current' browsers... |
@MSP-Greg yeah, in theory I agree with you, in practice your mileage may vary with trying to embed svgs in GFMD and the github ecosystem... |
It took quite a bit of digging into Puma source to get the architectural sense I needed for some recent load testing / tuning tasks.
I created some internal documentation for our team that I figured I would see if y'all thought belonged here.
Happy to discuss or change in any way, my goal is to help those wanting to understand more who don't have the time or confidence to dig in the source to understand more. It would have helped me.