Docs on upgrading blocks

openplans · May 2, 2012 · 931f59d · 931f59d
1 parent 4cd34aa
commit 931f59d
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 5 deletions.
diff --git a/docs/changes/release_notes.rst b/docs/changes/release_notes.rst
@@ -24,6 +24,26 @@ Upgrade Notes
    django-admin.py syncdb
    django-admin.py migrate
 
+* In this release, there are some changes to the Block model and the
+  import script, which combine to give you better search results and
+  geocoding if you reload your blocks data.  To do so:
+
+  * Run migrations, as described above
+  * Shut down your scrapers
+  * Back up your database
+  * Re-import blocks **with the --reset option** (that's important!), via either
+    the admin UI or the command line ... see http://openblockproject.org/docs/install/geodata.html#streets-blocks
+  * Be sure to also regenerate the Streets, BlockIntersections, and
+    Intersections as per the docs.
+  * Browse your site... everything should work except that streets
+    with previously cryptic names like "99" or "87" will now have a
+    more recognizable full name, eg. "State Route 99" or "Interstate
+    87".
+  * Start your scrapers again.
+
+  The website should remain operational during this process, though
+  some pages may briefly give errors during the process, and URLs for
+  highways will change to include the prefix.
 
 Backward Incompatibilities
 --------------------------

diff --git a/docs/install/geodata.rst b/docs/install/geodata.rst
@@ -282,23 +282,30 @@ all options:
  
  Options:
   -h, --help            show this help message and exit
-  -v, --verbose
+  -v, --verbose         
   -c CITY, --city=CITY  A city name to filter against
   -f, --fix-cities      Whether to override "city" attribute of blocks and
                         streets by finding an intersecting Location of a city-
                         ish type. Only makes sense if you have configured
                         multiple_cities=True in the METRO_LIST of your
                         settings.py, and after you have created some
                         appropriate Locations.
-  -b, --filter-bounds   Whether to skip blocks outside the metro extent from
-                        your settings.py. Default True.
+  -r, --reset           Whether to delete existing blocks and start from
+                        scratch. This will attempt to fix other models that
+                        have foreign keys to blocks; use at your own risk
+                        though.
+  -b FILTER_BOUNDS, --filter-bounds=FILTER_BOUNDS
+                        Whether to skip blocks outside the metro extent from
+                        your settings.py. Default 1 (true); use 0 to disable.
+  -l FILTER_LOCATION, --filter-location=FILTER_LOCATION
+                        A location (spelled as location-type-slug:location-
+                        slug) that will be used to filter out blocks outside
+                        its boundaries. May be passed more than once.
   -e ENCODING, --encoding=ENCODING
                         Encoding to use when reading the shapefile
 
 
 
-
-
 Loading Blocks from ESRI files
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~