nodeSolidServer / nodeSolidServer/node-solid-server
Disclaimer in README.md about non-production readiness
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.8k
- Forks
- 308
- PR merge metrics
- No merged PRs in 30d
Description
Can we add a disclaimer in the README that NSS should not be used with production data? I've found that it's used in production and marketed as a "secure" place to store your data.
There's already following disclaimer in the index.html file:
This is a prototype implementation of a Solid server. It is a fully functional server, but there are no security or stability guarantees.
I think it serves the purpose of a prototype server well. But I think we should copy this disclaimer to the README to make clear expectations.
(And while it would be nice to get it production ready, I suppose there are not enough resources to make it secure in the near future)
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
Compare the existing disclaimer in index.html with README.md, starting at the README introduction or project description. Done means the README clearly includes the same prototype, security, and stability warning; no code changes are indicated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100