search

a-b-street / docs

Technical and user documentation for A/B Street
Apache License 2.0
12 stars 7 forks source link

Add info on editing data.json #23

Closed Robinlovelace closed 3 years ago

Robinlovelace commented 3 years ago

I'm not sure that this is correct but it worked for me and is good to show an example of what the file could look like. I assume that this file is auto-updated if you opt to download data from more cities from the GUI but not sure, worth saying explicitly either way I think. Any follow-up changes to this welcome and happy to pause this if it will change more with the cli changes... I think there could be a helper function to add a new city e.g this totally made up example:

abcli add_city leeds

that would auto edit the file to avoid having to edit it directly and risk making a mistake in the fiddly JSON syntax.

dabreegster commented 3 years ago

Thanks for improving the instructions here! Looks good as it is.

I'm not sure it's worth adding a CLI command to manage this file. I updated this developer guide to start with "This guide is meant for people who want to work on A/B Street's code. In most cases as a user, even for importing new cities, you shouldn't need to bother with any of this." The GUI should be easy to use for most people. If somebody's following the developer guide, we're assuming the audience is more technical and comfortable editing JSON. If not, they can do things the easy way with the GUI. My hope was the data.json file was self-explanatory to such an audience, but I think this PR makes it even more clear, so -- awesome!

Robinlovelace commented 3 years ago

Sounds reasonable, see your point re developers and this should make it easier for people new to JSON editing. Just deleted the branch, thanks for merging!