sephii/django

The Web framework for perfectionists with deadlines.

Django is a high-level Python Web framework that encourages rapid development and clean, pragmatic design. Thanks for checking it out.

All documentation is in the "docs" directory and online at https://docs.djangoproject.com/en/stable/. If you're just getting started, here's how we recommend you read the docs:

• First, read docs/intro/install.txt for instructions on installing Django.
• Next, work through the tutorials in order (docs/intro/tutorial01.txt, docs/intro/tutorial02.txt, etc.).
• If you want to set up an actual deployment server, read docs/howto/deployment/index.txt for instructions.
• You'll probably want to read through the topical guides (in docs/topics) next; from there you can jump to the HOWTOs (in docs/howto) for specific problems, and check out the reference (docs/ref) for gory details.
• See docs/README for instructions on building an HTML version of the docs.

Docs are updated rigorously. If you find any problems in the docs, or think they should be clarified in any way, please take 30 seconds to fill out a ticket here: https://code.djangoproject.com/newticket

To get more help:

• Join the #django channel on irc.freenode.net. Lots of helpful people hang out there. Read the archives at http://django-irc-logs.com/.
• Join the django-users mailing list, or read the archives, at https://groups.google.com/group/django-users.

To contribute to Django:

• Check out https://www.djangoproject.com/community/ for information about getting involved.

To run Django's test suite:

• Follow the instructions in the "Unit tests" section of docs/internals/contributing/writing-code/unit-tests.txt, published online at https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/#running-the-unit-tests

django's Issues

Merge GEOS, GDAL and measurement docs

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.

Revamp tutorial

• 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)

Reference the OGR inspection page from the management commands page

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.

Remove section "GeoDjango utilities"

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

Add some model fields documentation

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

Add some forms documentation

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

Document KMLSitemap and KMZSitemap

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

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

Remove "Deploying GeoDjango" section

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

Document form field classes

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

Rename forms API documentation

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

Change the name GeoDjango

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?

Get rid of "GeoDjango" references in pages titles

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

Document OGR inspection functions

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

Document SyndicationFeed Subclasses

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

Split measurement docs in 2

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/

Do something out of geodjango.org

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

Improve GeoIP2 docs

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

Take out the "GeoDjango tests" part out of the tests docs

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