docs: Update Docs for Cluster Mode to indicate support for unix sockets
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 43.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
The cluster mode docs say
The cluster mode allows networked Node.js applications (http(s)/tcp/udp server) to be scaled across all CPUs available
with no mention of Unix sockets.
Latest in the paragraph it does say
Under the hood, this uses the Node.js cluster module
And Node's cluster mode supports unix sockets. The docs should therefore be updated to explicitly mention unix sockets as well.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the cluster mode documentation paragraph quoted in the issue and read the surrounding section. Update it to explicitly mention Unix sockets alongside the listed server types, then verify the documentation renders correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100