sephii / django Goto Github PK

And put it in a new doc like "Contributing to GeoDjango".

The warning could be put in the "Installation" docs.

Split the measurement docs in a guide and a reference docs (for the API part). We could then use the same notation as the Django form docs:

See also

The Forms Reference
    Covers the full API reference, including form fields, form widgets, and form and field validation.

https://docs.djangoproject.com/en/dev/ref/contrib/gis/measure/

https://docs.djangoproject.com/en/dev/ref/contrib/gis/sitemaps/

Also make sure it's something that's still used.

Add an introdution explaining what problem this module solves before the how it does it.

https://docs.djangoproject.com/en/dev/ref/contrib/gis/feeds/

Eg. https://docs.djangoproject.com/en/dev/ref/contrib/gis/forms-api/

Change the name GeoDjango? The current name seems to imply that the project is separated from Django itself. Rename it to something more specific like django.contrib.gis?

And create a section called "Common usecases", which would regroup the following:

• Importing data (LayerMapping)
• OGR inspection
• Serializing geo data to JSON
• Create geographic feeds
• Create geographic sitemaps

• Part 1: model creation + basic database queries (basic distance stuff)
• Part 2: more advanced database queries (volume intersection, buffers, ...)
• Part 3: admin
• Part 4: frontend integration (Leaflet?) + forms (edit form)

The current documentation lacks information on the different field types and how they can be used.

https://docs.djangoproject.com/en/dev/ref/contrib/gis/commands/ should reference https://docs.djangoproject.com/en/dev/ref/contrib/gis/ogrinspect/ instead of the tutorial page.

The current docs lack examples on the different form fields and how to use them.

Get rid of geodjango.org or make something really useful out of it

Current docs just present GDAL, GEOS and measurement objects as separate topics. We should present these topics in a way that makes more sense to the user. For example:

Dealing with geographical data

• Geometry objects (GEOS)
• Measurements
• Advanced geographical manipulation (GDAL)

Also move all the "references" part (API docs) into the References section and make sure classes and methods names are referenced to the actual objects.

... to something like "Built-in form fields and widgets"

Because it doesn't bring any value and the user already knows they're looking at the GIS docs.

https://docs.djangoproject.com/en/dev/ref/contrib/gis/ogrinspect/