Skip to content

Commit

Permalink
Update doc lins
Browse files Browse the repository at this point in the history
  • Loading branch information
sharkAndshark committed Oct 27, 2023
1 parent 996cd6d commit 756b9b1
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ See [Martin book](https://maplibre.org/martin/) for complete documentation.
![Martin](https://raw.githubusercontent.com/maplibre/martin/main/logo.png)

## Installation
_See [installation instructions](https://maplibre.org/martin/installation.html) in the Martin book._
_See [installation instructions](https://maplibre.org/martin/10-installation.html) in the Martin book._

**Prerequisites:** If using Martin with PostgreSQL database, you must install PostGIS with at least v3.0+, v3.1+ recommended.

Expand Down Expand Up @@ -45,11 +45,11 @@ brew install martin
```

## Running Martin Service
_See [running instructions](https://maplibre.org/martin/run.html) in the Martin book._
_See [running instructions](https://maplibre.org/martin/20-run.html) in the Martin book._

Martin supports any number of PostgreSQL/PostGIS database connections with [geospatial-enabled](https://postgis.net/docs/using_postgis_dbmanagement.html#geometry_columns) tables and tile-producing SQL functions, as well as [PMTile](https://protomaps.com/blog/pmtiles-v3-whats-new) and [MBTile](https://github.com/mapbox/mbtiles-spec) files as tile sources.

Martin can auto-discover tables and functions using a [connection string](https://maplibre.org/martin/PostgreSQL-Connection-String.html). A PG connection string can also be passed via the `DATABASE_URL` environment variable.
Martin can auto-discover tables and functions using a [connection string](https://maplibre.org/martin/31-pg-connections.html). A PG connection string can also be passed via the `DATABASE_URL` environment variable.

Each tile source will have a [TileJSON](https://github.com/mapbox/tilejson-spec) endpoint.

Expand All @@ -72,7 +72,7 @@ martin --config config.yaml
```

#### Docker Example
_See [Docker instructions](https://maplibre.org/martin/run-with-docker.html) in the Martin book._
_See [Docker instructions](https://maplibre.org/martin/22-run-with-docker.html) in the Martin book._

Martin is also available as a [Docker image](https://ghcr.io/maplibre/martin). You could either share a configuration file from the host with the container via the `-v` param, or you can let Martin auto-discover all sources e.g. by passing `DATABASE_URL` or specifying the .mbtiles/.pmtiles files.

Expand All @@ -86,7 +86,7 @@ docker run -p 3000:3000 \
```

## API
_See [API documentation](https://maplibre.org/martin/using.html) in the Martin book._
_See [API documentation](https://maplibre.org/martin/40-using.html) in the Martin book._

Martin data is available via the HTTP `GET` endpoints:

Expand Down
2 changes: 1 addition & 1 deletion debian/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ listen_addresses: '0.0.0.0:3000'
# Number of web server workers
worker_processes: 8

# see https://maplibre.org/martin/config-file.html
# see https://maplibre.org/martin/30-config-file.html

# postgres:
# connection_string: 'postgresql://postgres@localhost:5432/db'
Expand Down
2 changes: 1 addition & 1 deletion docs/src/32-sources-pg-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The TileJSON:
}
```

By default the `description` and `name` is database identifies about this table, and the bounds is queried from database. You can fine tune these by adjusting `auto_publish` section in [configuration file](https://maplibre.org/martin/config-file.html#config-example).
By default the `description` and `name` is database identifies about this table, and the bounds is queried from database. You can fine tune these by adjusting `auto_publish` section in [configuration file](https://maplibre.org/martin/30-config-file.html#config-example).

## TileJSON in SQL Comments

Expand Down
4 changes: 2 additions & 2 deletions martin-mbtiles/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# martin-mbtiles

[![Book](https://img.shields.io/badge/docs-Book-informational)](https://maplibre.org/martin/tools.html)
[![Book](https://img.shields.io/badge/docs-Book-informational)](https://maplibre.org/martin/50-tools.html)
[![docs.rs docs](https://docs.rs/martin-mbtiles/badge.svg)](https://docs.rs/martin-mbtiles)
[![Slack chat](https://img.shields.io/badge/Chat-on%20Slack-blueviolet)](https://slack.openstreetmap.us/)
[![GitHub](https://img.shields.io/badge/github-maplibre/martin-8da0cb?logo=github)](https://github.com/maplibre/martin)
Expand All @@ -9,7 +9,7 @@

A library to help tile servers like [Martin](https://maplibre.org/martin) work with [MBTiles](https://github.com/mapbox/mbtiles-spec) files. When using as a lib, you may want to disable default features (i.e. the unused "cli" feature).

This crate also has a small utility that allows users to interact with the `*.mbtiles` files from the command line. See [tools](https://maplibre.org/martin/tools.html) documentation for more information.
This crate also has a small utility that allows users to interact with the `*.mbtiles` files from the command line. See [tools](https://maplibre.org/martin/50-tools.html) documentation for more information.

### Development

Expand Down

0 comments on commit 756b9b1

Please sign in to comment.