Skip to content

Commit 8f14fc3

Browse files
committed
A variety of documentation improvements and cleanup.
1 parent f1749ea commit 8f14fc3

File tree

5 files changed

+31
-10
lines changed

5 files changed

+31
-10
lines changed

docs/src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
- [pgRouting 4](./routing-4.md)
2121
- [Processing Time](./performance.md)
2222

23-
# Production usages
23+
# Production Use
2424

2525
- [Postgres Permissions](./postgres-permissions.md)
2626
- [Using External Postgres Connection](./postgres-external.md)

docs/src/quick-start.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -235,11 +235,15 @@ From the perspective of database design, the `osm.unitable` option is the **wors
235235
This table violates all sorts of best practices established in this project
236236
by shoving all features into a single unstructured table.
237237

238-
> This style included in PgOSM Flex is intended to be used for troubleshooting and quality control. It is not intended to be used for real production workloads! This table is helpful for exploring the full data set when you don't really know what you are looking for, but you know **where** you are looking.
238+
The Unitable data is loaded with the `everything` layerset.
239+
Of course, you can create your own customized layerset including this style
240+
if needed.
239241

240-
Unitable is loaded with the `everything` layerset. Feel free to create your own
241-
customized layerset if needed.
242242

243+
> The `osm.unitable` table is intended to be used for troubleshooting and
244+
> quality control. It is not intended to be used for production workloads!
245+
> This table is most helpful for exploring the full data set when you don't
246+
> really know what you are looking for, but you know **where** you are looking.
243247
244248

245249
```bash

docs/src/readme.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PgOSM Flex
1+
# About PgOSM Flex
22

33
PgOSM Flex ([GitHub](https://github.com/rustprooflabs/pgosm-flex))
44
provides high quality OpenStreetMap datasets in PostGIS using the
@@ -33,7 +33,7 @@ A few decisions made in this project:
3333
* Defaults to same units as OpenStreetMap (e.g. km/hr, meters)
3434
* Data not included in a dedicated column is available from `osm.tags.tags` (`JSONB`)
3535
* Points, Lines, and Polygons are not mixed in a single table
36-
* Tracks latest Postgres, PostGIS, and osm2pgsql versions
36+
* Tracks latest Postgres, PostGIS, osm2pgsql, and pgRouting versions
3737

3838
This project's approach is to do as much processing in the Lua styles
3939
passed along to osm2pgsql, with post-processing steps creating indexes,
@@ -72,6 +72,8 @@ package used to determine the best osm2pgsql command assumes fast SSDs.
7272

7373
## RustProof Labs project
7474

75-
PgOSM Flex is a RustProof Labs project developed and maintained by Ryan Lambert.
75+
PgOSM Flex is a RustProof Labs project developed and maintained
76+
by Ryan Lambert and
77+
[contributors](https://github.com/rustprooflabs/pgosm-flex/graphs/contributors).
7678
See the [RustProof Labs blog](https://blog.rustprooflabs.com/category/pgosm-flex)
7779
for more resources and examples of using PgOSM Flex.

docs/src/routing-3.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
1-
# Routing with PgRouting 3
1+
# Routing with pgRouting 3
22

3-
> If you are using a pgRouting 4.0 or later see [Routing with pgRouting 4](./routing-4.md).
3+
If you are using a pgRouting 4.0 or later see [Routing with pgRouting 4](./routing-4.md).
4+
New development in PgOSM Flex will focus support on pgRouting 4.0 support.
5+
[PgOSM Flex 1.1.2](https://github.com/rustprooflabs/pgosm-flex/releases/tag/1.1.2)
6+
includes a simplified and higher performance implementation of the routing
7+
data preparation.
8+
9+
10+
> ⚠️ This page will remain in the PgOSM documentation through at least 2026 to ensure
11+
> continuity for a transition to pgRouting 4.0.
12+
> There will not be improvements made to these legacy instructions.
13+
14+
Create the `pgRouting` extension.
15+
16+
```sql
17+
CREATE EXTENSION IF NOT EXISTS pgrouting;
18+
```
419

520

621
## Clean the data

docs/src/routing-4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Routing with PgRouting 4
1+
# Routing with pgRouting 4
22

33
> If you are using a pgRouting prior to 4.0 see [Routing with pgRouting 3](./routing-3.md).
44

0 commit comments

Comments
 (0)