More documentation needed for editing an existing database
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 66/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- json, python, sqlite
- Domain
- databases, documentation
Research direction
Start by reading the existing documentation and schema pages to find their structure and links. Add dedicated pages explaining how to edit the database with a SQLite browser or other apps and directly through JSON files; consider a page for the listed foreign key and primary key gotchas. Done means the pages explain these workflows and link to the relevant schema pages.
Written by the indexing model from the issue text.
Description
Make dedicated documentation pages for editing the database with 1) SQLite browser (or other apps) and 2) JSON files directly.
Maybe a third page for common gotchas
- FOREIGN KEY violations - need to make sure the value is in the valueList table. New sources need to be in Sources table first. New References need to be in PublicationsList first. Link to schema pages.
- PRIMARY KEY violations - can't have duplicates. Link to schema pages.
- Dominant language
- Python
- Stars
- 0
- Forks
- 10
- Avg merge
- 15h 13m
- Merged PRs (30d)
- 3
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- No pull request template
- No contributing 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.
More from astrodbtoolkit/astrodb_utils
-
Update astrodb_bot documentationPossibly taken @kelle claimed this 8 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
astrodbtoolkit/astrodb_utils#263 · 1 comment ·
-
Difficulty 2/5 Half a day Newbie friendliness 62/100
astrodbtoolkit/astrodb_utils#186 ·
-
dev-docs
Difficulty 1/5 Under an hour Newbie friendliness 68/100
astrodbtoolkit/astrodb_utils#172 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
astrodbtoolkit/astrodb_utils#278 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
astrodbtoolkit/astrodb_utils#270 ·
All issues in astrodbtoolkit/astrodb_utils
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
NVlabs/physical_ai_av#29 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
UKGovernmentBEIS/inspect_ai#6666 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day