📚 [Documentation] - How to edit "Cliopatria" borders shape dataset

[edwardchalstrey1]

Pre-requisites

• 112

Section of Documentation

Developer, RA

Description of Improvement

We need to document the way in which the Cliopatria borders dataset can be edited via suggestions from the Seshat project website.

• [x] Determine whether Cliopatria will have it's own GitHub repo under the Seshat-Global-History-Databank org - Update: Yes - see #60
• [ ] We need to figure out the full process for making edits and document it. Could be something like:
  • Based on an edit request that the Seshat admin fields via the website, the admin opens an issue on the Cliopatria repo according to an issue template. The template should be specific enough that an RA can understand the issue and make the required edits, e.g. fields for the polity name, year etc. An RA who knows how to make updates to Cliopatria should get auto-assigned to the issue.
  • The RA uses the same process/tools they used for creating Cliopatria to make edits and releases a new version via the Cliopatria repo (if the RA disagrees use either GitHub comments on the issue or whatever method already exists in the Seshat website for handling/discussing edit disputes)
  • The RA releases the new version of Cliopatria and creates an issue for the Seshat developer(s) to update the site with the new version

Question: once Seshat uploads a stable v1 release of Cliopatria, will future versions of Cliopatria be:

• Created downstream of edits coming via Seshat, with the Seshat database becoming the source of truth for our borders dataset or
• Will Seshat intend to consume future versions/releases of Cliopatria which are updated independently of Seshat or
• Some combination of these

TODO

• [ ] Meet to discuss this with the project team
• [ ] Add to docs detailing how it will work

Benefits of Improvement

Clear ways of working for the project

Additional Context

As of 16th July 2024 there is yet to be a public release of Cliopatria. The intention is to release it soon alongside a publication, now that the GeoJSON format has been stabilised and further updates are only related to content rather than structure. Seshat is already set up to load Cliopatria into a table in the database for visualisation in the Django app.

[edwardchalstrey1]

Currently, the edit process will be simply to make use of the existing request system for RAs, but they can quote the Shape ID when suggesting an edit

[edwardchalstrey1]

Update: Originally I had planned to work through this in the Vienna workshop, however I now think it would be better to work through this separately on a call with Jim