diff --git a/docs/docs/Dev/bootstrapsh.md b/docs/docs/Dev/bootstrapsh.md index 32e7b85b..1618b33f 100644 --- a/docs/docs/Dev/bootstrapsh.md +++ b/docs/docs/Dev/bootstrapsh.md @@ -54,3 +54,4 @@ Will look for these files: ecuador-latests.osm.pbf ecuador.poly ``` + diff --git a/docs/docs/Dev/changefile.md b/docs/docs/Dev/changefile.md index 88a3ff32..103f58cf 100644 --- a/docs/docs/Dev/changefile.md +++ b/docs/docs/Dev/changefile.md @@ -102,6 +102,9 @@ state.txt file from planet, scanning for files isn't really practical. Once the proper data file is found, then it's easy to just download the next data file in sequence. -Underpass has a table in it's database to store the timestamps, and -paths to the data files. That makes it possible to quickly find the -appropriate starting data file. +Currently, the function `PlanetReplicator::findRemotePath` is the one +responsible for returning the file path from a timestamp. It's using +a list of of timestamps and sequence numbers stored in a local file +located in `config/replicator/confiplanetreplicator.yaml` for +calculating the path. This approach must be reviewed in order to +have better precision without the need of keeping that file up-to-date. \ No newline at end of file diff --git a/docs/docs/Dev/chroots.md b/docs/docs/Dev/chroots.md index b3f1ec85..43cfa169 100644 --- a/docs/docs/Dev/chroots.md +++ b/docs/docs/Dev/chroots.md @@ -1,4 +1,6 @@ -# Building Packages in a Chroot +[ THIS DOCUMENT NEEDS REVIEW ] + +# Building Packages in a Chroot To distribute binary packages for a variety of platforms of varying versions, it's common to use a *chroot* to build in. This is to make diff --git a/docs/docs/Dev/dataflow.md b/docs/docs/Dev/dataflow.md index 20123aeb..26f9a735 100644 --- a/docs/docs/Dev/dataflow.md +++ b/docs/docs/Dev/dataflow.md @@ -1,5 +1,7 @@ # Underpass Data Flow +![Flow Chart](dataflow.png) + The Overpass data storage contains information from several sources. Underpass has to duplicate this collection of data and aggregate it into a similar structure. The primary data is the map @@ -127,5 +129,3 @@ Underpass currently writes to 1 primary database: the *underpass* database, which stores all the calculated statistics, data validation results and raw OSM data that also gets updated every minute. -  -![Flow Chart](dataflow.png) diff --git a/docs/docs/get-started/Install.md b/docs/docs/get-started/Install.md index 0f586177..71fc16c9 100644 --- a/docs/docs/get-started/Install.md +++ b/docs/docs/get-started/Install.md @@ -2,11 +2,15 @@ If you want to get started really quick and easy, use the [Docker installation](/Dev/install-with-docker) +## Build from source + +Check the [build documentation](/get-started/Build) + ## Linux -`apt-get install underpass` +`apt-get install underpass` (not available yet) ## MacOS -`brew install underpass` +`brew install underpass` (not available yet) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b7206e60..2c503d4f 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -75,6 +75,7 @@ nav: - Developers: - Coding: Dev/coding.md - Debugging: Dev/debugging.md + - ChangeFile: Dev/changefile.md - Data flow: Dev/dataflow.md - Engine: Dev/engine.md - OSM Stats: Dev/osmstats.md @@ -82,4 +83,5 @@ nav: - Validation: Dev/validation.md - Replication: Dev/replication.md - Utility: Dev/utility.md + - Chroots: Dev/chroots.md