Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Cliopatria repo and documentation for it #60

Closed
15 tasks done
edwardchalstrey1 opened this issue Aug 15, 2024 · 1 comment · Fixed by #73
Closed
15 tasks done

Create Cliopatria repo and documentation for it #60

edwardchalstrey1 opened this issue Aug 15, 2024 · 1 comment · Fixed by #73
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@edwardchalstrey1
Copy link

edwardchalstrey1 commented Aug 15, 2024

Ed TODOs

  • Create a new repo under the Seshat-Global-History-Databank org for "Cliopatria" polity borders dataset
  • Include the script for simplification (and python environment etc)
  • Ensure that @jbennettgit and others in the Cliopatria team are maintainers, e.g. Jenny Reddish
  • Add documentation to the Cliopatria repo README
    • This page includes how to create a new release of Cliopatria via the GitHub repo and the versioning system. We could start with version 1.0.0 where the major number increment indicates a breaking change to the Cliopatria geojson structure, middle number is a major update and last number is a small edit
  • Could move everything in seshat/cliopatria to this new repo (this includes the script that adds colours and a Jupyter notebook for looking at Cliopatria data)
  • This page also includes general info on how to use Cliopatria run any processing scripts (such as the simplification script, the Seshat processing script that adds colours)
  • Test instructions and make a v0.0.0 tag (can remove this later)
  • Send instructions to Jim Bennett so he can test again and add license
  • Link the repo to Zenodo and ensure releases get pushed to Zenodo
  • Create a Cliopatria page on Seshat docs site that links to the Cliopatria README
  • Remove the cliopatria folder from the Seshat repo
  • Add automated check for GeoJSON structure and lock main branch This won't work because we're now uploading a zip instead of the GeoJSON, since it is too large
  • Update the page on how to update Seshat GIS with Cliopatria
  • Include links on the Cliopatria README to the Seshat world map and polity maps pages

Jim TODOs

@edwardchalstrey1
Copy link
Author

edwardchalstrey1 commented Aug 20, 2024

Draft GitHub process for Cliopatria repo and making releases:

  • there's a main branch
  • you open a new branch for each new release which replaces the GeoJSON with the new one, making use of the pull request feature and set up some checks
    • Automated e.g. the GeoJSON format is uncorrupted
    • manual: the uploader has loaded the data on the map (e.g. in the Cliopatria notebook) and it looks good
  • The PR is merged
  • A release is made after the PR merge and the version number incremented (see above)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant