Referencing known bugs in documentation
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
I feel like there are some issues in RethinkDB - whether by design or otherwise - and at least from an outsider's perspective these might be surprising and unpleasant. Right now, a lot of these are probably performance issues, e.g. don't use filter when you want to use getAll, etc.
I was wondering if we could start using a new subheading Known issues when documenting individual commands, and list the most relevant, verified issues from the rethinkdb/rethinkdb project.
For example, I would reference https://github.com/rethinkdb/rethinkdb/issues/6012 in api/skip page.
I feel with RethinkDB becoming an open project, the development velocity will go down at first - likely we won't get 4 major releases per year like in 2015 - which means bugs will survive longer than before, thus documenting them won't be as temporary as before.
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 reading the proposed api/javascript/transformations/skip.md page and the linked RethinkDB issue 6012. Determine which verified issues are relevant to individual command documentation and how a Known issues subsection should be applied. Done would require an agreed scope and documented references, but this issue does not define the full set of pages or criteria.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100