From 348ee4a0e2fc55a814a1f3dd86371cb69f2d6ad9 Mon Sep 17 00:00:00 2001 From: Bertil Chapuis Date: Wed, 24 Jul 2024 14:05:04 +0200 Subject: [PATCH] Fix broken links --- src/pages/documentation/developer-manual.mdx | 2 +- .../documentation/developer-manual/ip-to-location.mdx | 10 +++++----- src/pages/documentation/examples.mdx | 4 ++-- .../examples/contour-lines-in-vector-tiles.mdx | 2 +- src/pages/documentation/examples/extrusion.mdx | 2 +- src/pages/documentation/examples/geocoding.mdx | 2 +- src/pages/documentation/examples/ip-to-location.mdx | 4 ++-- .../examples/serve-and-export-vector-tiles.mdx | 2 +- src/pages/index.mdx | 2 +- 9 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/pages/documentation/developer-manual.mdx b/src/pages/documentation/developer-manual.mdx index 1c925b8a..030e41b5 100644 --- a/src/pages/documentation/developer-manual.mdx +++ b/src/pages/documentation/developer-manual.mdx @@ -14,4 +14,4 @@ Go into the relevant sections to find out more about Apache Baremaps. - [Set up in IntelliJ IDEA](/documentation/developer-manual/setup-in-intellij/) - [Geocoder](/documentation/developer-manual/geocoder/) - [IP to location](/documentation/developer-manual/ip-to-location/) -- [Stylesheet](/documentation/developer-manual/basemap) +- [Schema and style](/documentation/basemap) diff --git a/src/pages/documentation/developer-manual/ip-to-location.mdx b/src/pages/documentation/developer-manual/ip-to-location.mdx index 85b80f40..85ae04d7 100644 --- a/src/pages/documentation/developer-manual/ip-to-location.mdx +++ b/src/pages/documentation/developer-manual/ip-to-location.mdx @@ -5,7 +5,7 @@ title: IP to location # IP to location -Using data publicly available from the 5 [Regional Internet Registries (RIRs)](https://whatismyipaddress.com/rir) +Using data publicly available from the 5 Regional Internet Registries (RIRs) we are able to generate a stream of objects detailing Internet resource allocations. We call these NIC Objects (Network Information Centre Objects). @@ -17,7 +17,7 @@ Here is the list of the 5 RIRs. - [RIPE NCC](https://www.ripe.net/) - [APNIC](https://www.apnic.net/) -Using the list of NIC objects, we extract those that concern IPv4 address ranges ([INETNUM](https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-database-documentation/rpsl-object-types/4-2-descriptions-of-primary-objects/4-2-4-description-of-the-inetnum-object)) +Using the list of NIC objects, we extract those that concern IPv4 address ranges (INETNUM) , then using the Baremaps Geocoder API, we iterate through the extracted NIC objects to geo-locate each one of them. The resulting geo-localised IPv4 address ranges are stored in a SQLite database which can be easily queried to geo-locate a specific IP. @@ -27,14 +27,13 @@ We try to use these 4 attributes to query the Geocoder service : - _address_ contains the address of the NIC Object - _descr_ sometimes contains the address of the NIC Object -- _country_ contains the country code in ISO format (ISO 3166) - [RIPE list of country codes](https://www.ripe.net/participate/member-support/list-of-members/list-of-country-codes-and-rirs) +- _country_ contains the country code in ISO format (ISO 3166) - _geoloc_ contains the latitude and longitude which can be used directly Some NIC Objects contain a reference to an organisation, and the organisation's NIC Object itself contains the geo-localisation information. However, we don't make use of that for now. -The [structure of the RIPE database](https://www.ripe.net/manage-ips-and-asns/db/support/documentation/ripe-database-documentation/ripe-database-structure) -should be applicable to all the RIRs. +The structure of the RIPE database should be applicable to all the RIRs. ## Generating the IP to location database @@ -107,5 +106,6 @@ tag _iploc_ if you want to contribute. ## References +- [https://apps.db.ripe.net/docs/](https://apps.db.ripe.net/docs/) - [https://www.iana.org/numbers](https://www.iana.org/numbers) - [https://www.irr.net/docs/list.html](https://www.irr.net/docs/list.html) diff --git a/src/pages/documentation/examples.mdx b/src/pages/documentation/examples.mdx index 22b0e10f..81c48371 100644 --- a/src/pages/documentation/examples.mdx +++ b/src/pages/documentation/examples.mdx @@ -12,13 +12,13 @@ repository in order to have access to the [files](https://github.com/apache/incu git clone git@github.com:apache/incubator-baremaps.git ``` -You should have completed the [Installation Guide](/getting-started/installing-the-cli) before running the examples. +You should have completed the [Installation Guide](/documentation/getting-started/installing-the-cli/) before running the examples. For the creation of custom vector tiles you can follow these guides: - The [OpenStreetMap](/documentation/examples/import-osm-into-postgis/) example shows how to import OpenStreetMap data into postgis and create minimalistic vector tiles (see the [basemap](https://baremaps.apache.org/documentation/basemap/) for a more detailed shema and style). - The [NaturalEarth](/documentation/examples/import-naturalearth-into-postgis/) example shows how to produce low resolution vector tiles. -- The [Contour](/documentation/examples/import-contour-into-postgis/) example shows how to produce contour lines from a digital elevation model. +- The [Contour](/documentation/examples/contour-lines-in-vector-tiles/) example shows how to produce contour lines from a digital elevation model. - The [Extrusion](/documentation/examples/extrusion/) example shows how to import OpenStreetMap data into postgis and use the MVT specification to extrude the vectors into 3d. For the creation of an IP to location service follow this guide: diff --git a/src/pages/documentation/examples/contour-lines-in-vector-tiles.mdx b/src/pages/documentation/examples/contour-lines-in-vector-tiles.mdx index 0356484f..6a419562 100644 --- a/src/pages/documentation/examples/contour-lines-in-vector-tiles.mdx +++ b/src/pages/documentation/examples/contour-lines-in-vector-tiles.mdx @@ -39,7 +39,7 @@ button to download the entire dataset. If you want to use a different DEM dataset, below is a list of some other options: -- [SRTM](https://www2.jpl.nasa.gov/srtm/) +- [SRTM](https://www.earthdata.nasa.gov/sensors/srtm) - [COPERNICUS-DEM](https://registry.opendata.aws/copernicus-dem/) (note: contains quite some artifacts) diff --git a/src/pages/documentation/examples/extrusion.mdx b/src/pages/documentation/examples/extrusion.mdx index be5b6d25..fba0fa98 100644 --- a/src/pages/documentation/examples/extrusion.mdx +++ b/src/pages/documentation/examples/extrusion.mdx @@ -68,7 +68,7 @@ baremaps map dev \ --style 'style.json' ``` -Well done, a map of London with extruded buildings should now appear in your [browser](http://localhost:9000/)! +Well done, a map of London with extruded buildings should now appear in your browser (`http://localhost:9000/`)! ![Tile viewer](/images/extrusion.png) diff --git a/src/pages/documentation/examples/geocoding.mdx b/src/pages/documentation/examples/geocoding.mdx index fca2366f..07b3e04f 100644 --- a/src/pages/documentation/examples/geocoding.mdx +++ b/src/pages/documentation/examples/geocoding.mdx @@ -28,7 +28,7 @@ The following command will serve the Geonames index over HTTP in a simple web ap baremaps geocoder serve --index geocoder-index --port 9000 ``` -Go to [http://localhost:9000/](http://localhost:9000/) to see it in action. +Go to your browser (`http://localhost:9000/`) to see it in action. ## Conclusion diff --git a/src/pages/documentation/examples/ip-to-location.mdx b/src/pages/documentation/examples/ip-to-location.mdx index 2dbe25ec..592d50f4 100644 --- a/src/pages/documentation/examples/ip-to-location.mdx +++ b/src/pages/documentation/examples/ip-to-location.mdx @@ -11,7 +11,7 @@ In this tutorial, we demonstrate how to create an IP to location index and then The data used to create an IP to location index is publicly available from the [Internet routing registries (IRRs)](https://www.irr.net/docs/list.html) which includes the [Regional Internet Registries (RIRs)](https://en.wikipedia.org/wiki/Regional_Internet_registry) -The data are formatted following [RPSL](https://www.irr.net/docs/rpsl.html) specifications and contain records that link IP address ranges to organisations along with some metadata. +The data are formatted following [RPSL](https://irr.net/rpsl-guide/) specifications and contain records that link IP address ranges to organisations along with some metadata. ## Generate the index @@ -32,7 +32,7 @@ The workflow executed in the above command does the following: baremaps iploc serve --database iploc.db --port 9000 ``` -A simple web application serves the Geonames index. Go to [http://localhost:9000/](http://localhost:9000/) to see it in action. +A simple web application serves the Geonames index. Go to your browser (`http://localhost:9000/`) to see it in action. ![ip-to-location](https://user-images.githubusercontent.com/238747/234003934-e10040e1-0fdc-45e9-95f5-322fb2401c97.png) diff --git a/src/pages/documentation/examples/serve-and-export-vector-tiles.mdx b/src/pages/documentation/examples/serve-and-export-vector-tiles.mdx index c7cc672e..a03fa0a1 100644 --- a/src/pages/documentation/examples/serve-and-export-vector-tiles.mdx +++ b/src/pages/documentation/examples/serve-and-export-vector-tiles.mdx @@ -40,7 +40,7 @@ baremaps map dev \ ``` Well done, a local development server should have started. -You can now visualize the vector tiles in your browser ([http://localhost:9000/](http://localhost:9000/))! +You can now visualize the vector tiles in your browser (`http://localhost:9000/`)! Notice that the changes in the configuration files are automatically reloaded by the browser. ### Under the Hood (Optional) diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 906b4822..356149a8 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -91,7 +91,7 @@ export function OSMCopyright() { index={3} large style={{ height: 450 }} - href="/documentation/developer-manual/basemap" + href="/documentation/basemap" >