More documentation needed for editing an existing database

Open Beginner friendly
#280 0 comments 0 reactions 0 assignees View on GitHub

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

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

documentation

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

Open in Codespaces

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from astrodbtoolkit/astrodb_utils

All issues in astrodbtoolkit/astrodb_utils

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.