Open rufuspollock opened 4 years ago
I'd like to minimize the amount of content in README and put most of the documentation in the docs
folder which contains Sphinx based documentation for the project, including a quick start guide. This allows for better organization of documentation and "single source of truth". It is also auto-published to readthedocs.io now.
We could improve README a bit to make it more explicit (so easier to actually get started) plus include some design info (may want to split into 2 issues)
Acceptance
Tasks
datapackage.json
Analysis
Questions
Example material to include
Example datapackage.json - in
examples
. This example has 2 data resources, one stored in lfs cloud storage, one that is "remote".Now your git repo will look like XXX
.lfsconfig
.gitattributes
data/resource1.csv
: