Write documentation on best practices for researcher DB access
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
During the review of the OONI Data & Systems Usage Policy document it came up that:
Maybe at some point it would be a good idea to add a "good practices" section with this kind of thing
@LDiazN
It would be great to write this up as part of a document inside of docs.ooni.org: https://github.com/ooni/data/blob/main/.github/workflows/build_docs.yml
also: https://docs.ooni.org/meta/
and https://docs.ooni.org/meta/#how-documentation-is-built
Contributor guide
No contributing guide indexed for this repository
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
Read the documentation build workflow at .github/workflows/build_docs.yml and the guidance in docs.ooni.org/meta/, including how documentation is built. Add a document or section in docs.ooni.org covering good practices for researcher database access, with the result included in the documentation build.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100