Fix README.md and GETTING_STARTED.md - Recommend sqlite for generation rather than mySQL #250

New Issue

paulj · 2025-01-27T10:51:26Z

paulj commented

2025-01-27 10:51:26 +00:00

The process works seamlessly with sqlite - mySQL requires more work.
Proposal: leave the mySQL documentation there, but add a comment recommending the use of sqlite for local generation.

(nb: I am making this issue and related pull request to test my workflow)

The process works seamlessly with sqlite - mySQL requires more work. Proposal: leave the mySQL documentation there, but add a comment recommending the use of sqlite for local generation. (nb: I am making this issue and related pull request to test my workflow)

paulj commented

2025-01-27 10:55:02 +00:00

Actually, I see that GETTING_STARTED.md only has instructions for SQLite. I propose removing the mySQL information from README.md for consistency.

rho_n commented

2025-01-28 01:34:09 +00:00

I would lean towards going the other way. I see your point where the GETTING_STARTED documentation assumes that MySQL is already installed, and doesn't explain creating the database. I would add that to the GETTING_STARTED documentation. While I think most development should be done against a local SQLite DB, various parts of the infrastructure still use the MySQL DB, (hub.hackerpublicradio.org, and even the main static site may still be built from the MySQL DB--but @ken_fallon would know if that is true). So it would be good to have those instructions for new developers.

I think emphasizing the use of SQLite is good though. Most people shouldn't need to install MySQL to help out.

I would lean towards going the other way. I see your point where the GETTING_STARTED documentation assumes that MySQL is already installed, and doesn't explain creating the database. I would add that to the GETTING_STARTED documentation. While I think most development should be done against a local SQLite DB, various parts of the infrastructure still use the MySQL DB, (hub.hackerpublicradio.org, and even the main static site may still be built from the MySQL DB--but @ken_fallon would know if that is true). So it would be good to have those instructions for new developers. I think emphasizing the use of SQLite is good though. Most people shouldn't need to install MySQL to help out.

paulj referenced this issue

2025-01-29 11:13:03 +00:00

Suggestion - have a file with a list of tool version numbers needed to process shows etc. #245

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: HPR/hpr_generator#250