Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is an overhaul of the earthmover docs. Specific changes include:
README.md
file to a docs site driven by Material & MkDocs (the same framework used for enabledataunion.org), which can be deployed to GitHub Pages via an automation, and which comes with a lot of nice features (like docs search). All the content from the oldREADME.md
has been moved into the docs site (with some slight edits and formatting changes). The docs site can be served locally withpip install mkdocs-material && mkdocs serve
.earthmover
(1).README.md
(which was getting quite long) into several pages (2).earthmover
, YAML and Jinja.dbt
: "earthmover project" and "packages" (instead of "bundles")My hope is that these improvements to the
earthmover
documentation will both be helpful to users and make it easier to continue to expand the docs as earthmover development continues.If this PR is merged to
main
, I believe the docs should automatically appear at https://edanalytics.github.io/earthmover.README.md
is now a thin description ofearthmover
pointing to that link, so when deployed, other places that showREADME.md
(like PyPI) should also direct folks to the new docs site.I would recommend that reviewers check out this branch, stand up these docs locally, and review them in detail. Feel free to leave comments about specific content changes, as well the general approach. Thanks!