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

Update README and Documentation for GeoTrellis 3.0 #3111



Copy link

commented Oct 2, 2019


NOTE: This shouldn't be merged until we're ready to cut the 3.0 release, otherwise we'll have incorrect information for GT 2.3 in the project README.

This is not intended to be a comprehensive update/rewrite. The intention of this PR is to streamline the information presented in the README and better highlight additional sources of information. It also intends to close a few specific outstanding issues, starting with #3016.


  • docs/CHANGELOG.rst updated, if necessary
  • docs guides update, if necessary
  • [-] New user API has useful Scaladoc strings
  • [-] Unit tests added for bug-fix or new feature


Other fixes:

  • Added missing pipeline guide to the sidebar
  • Updated version and copyright in docs config
  • Fixed minor issue where we don't specify python 3 in the docs make serve command

Closes #3016

@CloudNiner CloudNiner force-pushed the CloudNiner:docs/awf/update-module-hierarchy#3016 branch from 156ffbd to 2ab662e Oct 2, 2019
@CloudNiner CloudNiner force-pushed the CloudNiner:docs/awf/update-module-hierarchy#3016 branch from dfae03d to b419fc7 Oct 9, 2019
@CloudNiner CloudNiner requested a review from pomadchin Oct 9, 2019

This comment has been minimized.

Copy link
Contributor Author

commented Oct 9, 2019

@pomadchin this is ready for review. I think I've gotten as far on this as I will for the 3.0 release.

docs/tutorials/setup.rst Outdated Show resolved Hide resolved
Copy link

left a comment

LGTM, after I'll bump libs versions in the setup.rst

@CloudNiner CloudNiner requested review from echeipesh and removed request for echeipesh Oct 14, 2019
CloudNiner added 6 commits Oct 2, 2019
- Move comprehensive feature list out of README.
  It already exists in ReadTheDocs, doesn't need
  to be duplicated.
- Shorten intro section and attempt a more succinct
  GT description
- Remove GeoPySpark section -- the project is on ice
- Remove mailing list ref, its basically dead.
  Everyone uses Gitter
- Update package list and descriptions
- Simplify documentation section, removing duplicate
- Add Module Hierarchy reminder to PR template

Move old history notes to bottom of README.
This happened awhile ago. While important to
preserve, it's a relatively large section
and we'd now prefer to highlight information
about what GT is along with examples, docs
and support.
The gdal, layer, macros, raster, spark-pipeline
and store sections were written by @pomadchin.
@CloudNiner CloudNiner force-pushed the CloudNiner:docs/awf/update-module-hierarchy#3016 branch from 464986f to a93f8c8 Oct 14, 2019
@pomadchin pomadchin removed the in progress label Oct 17, 2019
Copy link

left a comment

Removed the in progress button, since it is done. All extra changes can be done in separate PRs / issues.


This comment has been minimized.

Copy link

commented Oct 17, 2019

Merging this one after #3128 to cut down a release.

@pomadchin pomadchin merged commit 7871e01 into locationtech:master Oct 17, 2019
2 checks passed
2 checks passed
continuous-integration/travis-ci/pr The Travis CI build passed
eclipsefdn/eca The author(s) of the pull request is covered by necessary legal agreements in order to proceed!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
2 participants
You can’t perform that action at this time.