From 6b31bbde2b0ae41fa763e4c896c39723efcf6053 Mon Sep 17 00:00:00 2001 From: danieldegroot2 <67521919+danieldegroot2@users.noreply.github.com> Date: Tue, 7 Jun 2022 17:31:45 +0200 Subject: [PATCH 1/9] Upgrade URLs Fixed small inconsistencies in URLs. --- CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index bf9c45fbb0..9f8c8242c3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -77,6 +77,6 @@ Changes to the Code of Conduct should be proposed as pull requests. ## Acknowledgements -This document is based on the [Go Code of Conduct](https://golang.org/conduct), which in turn has parts derived from the Code of Conduct documents of the Django, FreeBSD, and Rust projects. +This document is based on the [Go Community Code of Conduct](https://go.dev/conduct), which in turn has parts derived from the Code of Conduct documents of the Django, FreeBSD, and Rust projects. This documented is licensed under the Creative Commons Attribution 3.0 License. From 4a862a36a4d28c9f0243bda8733ca8da91ce0839 Mon Sep 17 00:00:00 2001 From: danieldegroot2 <67521919+danieldegroot2@users.noreply.github.com> Date: Tue, 7 Jun 2022 17:48:48 +0200 Subject: [PATCH 2/9] Upgrade URLs Fixed small inconsistencies in URLs. Left workflow link as-is. --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 725ccf7c3e..2d0200500a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,13 +34,13 @@ images might not be sufficient and a demo layer is necessary. pnorman has a serv ## Easy pickings -Some [easy issues](https://github.com/gravitystorm/openstreetmap-carto/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) have been selected +Some [easy issues](labels/good%20first%20issue) have been selected that are particularly suitable for new contributors to get familiar with the project's code base and the contribution process. ## Editing layers OpenStreetMap Carto uses a YAML file for defining layers, because it [works much -better for big projects](https://github.com/gravitystorm/openstreetmap-carto/issues/711). +better for big projects](issues/711). This requires CartoCSS 0.18.0 or later. If you need JSON MML, you can generate it with `python -c 'import sys, yaml, json; json.dump(yaml.safe_load(sys.stdin), sys.stdout)' < project.mml > project.json` or the equivalent in a different language. @@ -148,8 +148,8 @@ Because SQL within JSON or YAML will not generally be syntax highlighted, indent ### External icon design resources The project's goals and design philsophy are different from other projects, but some external resources with general information about icon design are: -* [Maki Icons Design Guidelines](https://www.mapbox.com/maki-icons/guidelines/) -* [GNOME Icon Design Guildelines](https://developer.gnome.org/hig/stable/icons-and-artwork.html.en) +* [Maki Icons Design Guidelines](https://labs.mapbox.com/maki-icons/guidelines/) +* [GNOME Icon Design Guildelines](https://developer.gnome.org/hig/guidelines/ui-icons.html) ## Typography From b7726eda6fb2e63859165eccb1faa2218ade9098 Mon Sep 17 00:00:00 2001 From: danieldegroot2 <67521919+danieldegroot2@users.noreply.github.com> Date: Tue, 7 Jun 2022 18:23:27 +0200 Subject: [PATCH 3/9] Upgrade and update URLs Fixed some small inconsistencies in URLs and updated all disfunctional links. Note, you may want to update the link for the database setup guide to [a newer version of Ubuntu](https://wiki.ubuntu.com/Releases). --- INSTALL.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 974260e74e..dd2ea838df 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,9 +1,9 @@ # Installation -This document describes how to manually configure your system for running OpenStreetMap Carto. If you prefer quick, platform independent setup for a development environment, without the need to install and configure tools by hand, follow a Docker installation guide in [DOCKER.md](https://github.com/gravitystorm/openstreetmap-carto/blob/master/DOCKER.md). +This document describes how to manually configure your system for running OpenStreetMap Carto. If you prefer quick, platform independent setup for a development environment, without the need to install and configure tools by hand, follow a Docker installation guide in [DOCKER.md](DOCKER.md). ## OpenStreetMap data -You need OpenStreetMap data loaded into a PostGIS database (see below for [dependencies](#dependencies)). These stylesheets expect a database generated with osm2pgsql using the pgsql backend (table names of `planet_osm_point`, etc), the default database name (`gis`), and the [lua transforms](https://github.com/openstreetmap/osm2pgsql/blob/master/docs/lua.md) documented in the instructions below. +You need OpenStreetMap data loaded into a PostGIS database (see below for [dependencies](#dependencies)). These stylesheets expect a database generated with osm2pgsql using the pgsql backend (table names of `planet_osm_point`, etc), the default database name (`gis`), and the [lua transforms](https://osm2pgsql.org/doc/manual.html#lua-tag-transformations) documented in the instructions below. Start by creating a database @@ -24,7 +24,7 @@ then grab some OSM data. It's probably easiest to grab an PBF of OSM data from [ osm2pgsql -G --hstore --style openstreetmap-carto.style --tag-transform-script openstreetmap-carto.lua -d gis ~/path/to/data.osm.pbf ``` -You can find a more detailed guide to setting up a database and loading data with osm2pgsql at [switch2osm.org](https://switch2osm.org/manually-building-a-tile-server-16-04-2-lts/). +You can find a more detailed guide to setting up a database and loading data with osm2pgsql at [switch2osm.org](https://switch2osm.org/serving-tiles/manually-building-a-tile-server-16-04-2-lts/). ### Custom indexes Custom indexes are required for rendering performance and are essential on full planet databases. @@ -65,9 +65,9 @@ On Ubuntu 16.04 or Debian Testing you can download and install most of the requi sudo apt-get install fonts-noto-cjk fonts-noto-hinted fonts-noto-unhinted fonts-hanazono ttf-unifont ``` -Noto Emoji Regular (*not* Noto Color Emoji) can be downloaded [from the Noto Emoji repository](https://github.com/googlei18n/noto-emoji). +Noto Emoji Regular (*not* Noto Color Emoji) can be downloaded [from the Noto Emoji repository](https://github.com/googlefonts/noto-emoji). -It might be useful to have a more recent version of the fonts for [rare non-latin scripts](#non-latin-scripts). The current upstream font release has also some more scripts and style variants than in the Ubuntu package. It can be installed [from source](https://github.com/googlei18n/noto-fonts/blob/master/FAQ.md#where-are-the-fonts). +It might be useful to have a more recent version of the fonts for [rare non-latin scripts](#non-latin-scripts). The current upstream font release has also some more scripts and style variants than in the Ubuntu package. It can be installed [from source](https://github.com/googlefonts/noto-fonts/blob/master/FAQ.md#where-are-the-fonts). DejaVu is packaged as `fonts-dejavu-core`. @@ -75,8 +75,8 @@ DejaVu is packaged as `fonts-dejavu-core`. The fonts can be downloaded here: -* [Noto homepage](https://www.google.com/get/noto/) and [Noto github repositories](https://github.com/googlei18n?utf8=%E2%9C%93&q=noto) -* [DejaVu homepage](http://dejavu-fonts.org/) +* [Noto homepage](https://www.google.com/get/noto/) and [Noto github repositories](https://github.com/googlefonts?utf8=%E2%9C%93&q=noto) +* [DejaVu homepage](https://dejavu-fonts.org/) * [Hanazono homepage](http://fonts.jp/hanazono/) * [Unifont homepage](http://unifoundry.com/) @@ -101,7 +101,7 @@ To display any map a database containing OpenStreetMap data and some utilities a * [PostgreSQL](https://www.postgresql.org/) * [PostGIS](https://postgis.net/) -* [osm2pgsql](https://github.com/openstreetmap/osm2pgsql#installing) to [import your data](https://switch2osm.org/loading-osm-data/) into a PostGIS database +* [osm2pgsql](https://github.com/openstreetmap/osm2pgsql#installing) to [import your data](https://switch2osm.org/serving-tiles/updating-as-people-edit/) into a PostGIS database * Python 3 with the psycopg2, yaml, and requests libraries (`python3-psycopg2` `python3-yaml` `python3-requests` packages on Debian-derived systems) * `ogr2ogr` for loading shapefiles into the database (`gdal-bin` on Debian-derived systems) @@ -110,7 +110,7 @@ To display any map a database containing OpenStreetMap data and some utilities a Some colours, SVGs and other files are generated with helper scripts. Not all users will need these dependencies * Python and Ruby to run helper scripts -* [Color Math](https://github.com/gtaylor/python-colormath) and [numpy](http://www.numpy.org/) if running generate_road_colors.py helper script (may be obtained with `pip install colormath numpy`) +* [Color Math](https://github.com/gtaylor/python-colormath) and [numpy](https://numpy.org/) if running generate_road_colors.py helper script (may be obtained with `pip install colormath numpy`) ### Additional deployment dependencies From 59e89bad74306591c9a788be58ccc7eef97fb8b0 Mon Sep 17 00:00:00 2001 From: danieldegroot2 <67521919+danieldegroot2@users.noreply.github.com> Date: Tue, 7 Jun 2022 19:30:05 +0200 Subject: [PATCH 4/9] Upgrade and simplify URLs Fixed some small inconsistencies in URLs and simplified reference links which are only called once. Alternatively, you may use the tile usage policy link between the parentheses instead of the tiles 'link'. "`OSMF tileservers ([Tile Usage Policy](https://operations.osmfoundation.org/policies/tiles/))`" For Mapnik (XML) stylesheets, also the link "`[Community list of Mapnik stylesheets](https://github.com/mapnik/mapnik/wiki/StyleShare)`" could be added. ( from https://wiki.openstreetmap.org/wiki/Stylesheets ) --- README.md | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index dbeb78e2b7..a1542d0a37 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![screenshot](https://raw.github.com/gravitystorm/openstreetmap-carto/master/preview.png) -These are the CartoCSS map stylesheets for the Standard map layer on [OpenStreetMap.org](https://www.openstreetmap.org). +These are the CartoCSS map stylesheets for the Standard map layer on [OpenStreetMap.org](https://www.openstreetmap.org/). The general purpose, the cartographic design goals and guidelines for this style are outlined in [CARTOGRAPHY.md](CARTOGRAPHY.md). @@ -10,7 +10,7 @@ These stylesheets can be used in your own cartography projects, and are designed to be easily customised. They work with [Kosmtik](https://github.com/kosmtik/kosmtik) and also with the command-line [CartoCSS](https://github.com/mapbox/carto) processor. -Since August 2013 these stylesheets have been used on the OSMF tileservers (tile.openstreetmap.org), and +Since August 2013 these stylesheets have been used on the [OSMF tileservers](https://operations.osmfoundation.org/policies/tiles/) (tile.openstreetmap.org), and are updated from each point release. They supersede the previous [XML-based stylesheets](https://github.com/openstreetmap/mapnik-stylesheets). # Installation @@ -60,14 +60,11 @@ versions. Care has been taken to not get too clever with variables and expressions. While these often make it easier to customise, experience has shown that over-cleverness -(e.g. [interpolated entities][cleverness]) can discourage contributions. - -[issues]: https://github.com/gravitystorm/openstreetmap-carto/issues -[cleverness]: https://github.com/openstreetmap/mapnik-stylesheets/blob/master/inc/settings.xml.inc.template#L16 +(e.g. [interpolated entities](https://github.com/openstreetmap/mapnik-stylesheets/blob/master/inc/settings.xml.inc.template#L16)) can discourage contributions. ## Database schema change (v4.x) -The v4.x series includes [osm2pgsql lua transforms](https://github.com/openstreetmap/osm2pgsql/blob/master/docs/lua.md) +The v4.x series includes [osm2pgsql lua transforms](https://osm2pgsql.org/doc/manual.html#lua-tag-transformations) and a hstore column with all other tags, allowing use of more OpenStreetMap data. Users need to reload their databases, v3.x compatibility is not maintained. @@ -76,7 +73,7 @@ to reload their databases, v3.x compatibility is not maintained. The v5.x series updates Lua tag transforms, linestring and polygon decisions have changed. -There are over [500 open requests][issues], some that have been open for years. +There are over [500 open requests](issues), some that have been open for years. These need reviewing and dividing into obvious fixes, or additional new features that need some cartographic judgement. @@ -85,15 +82,15 @@ that need some cartographic judgement. There are many open-source stylesheets written for creating OpenStreetMap-based maps using Mapnik, many based on this project. Some alternatives are: -* [OSM-Bright](https://github.com/mapbox/osm-bright) -* [XML-based stylesheets](https://trac.openstreetmap.org/browser/subversion/applications/rendering/mapnik) -* [osmfr-cartocss](https://github.com/cquest/osmfr-cartocss) -* [openstreetmap-carto-german](https://github.com/giggls/openstreetmap-carto-de) +* [OSM Bright](https://github.com/mapbox/osm-bright) +* [XML-based stylesheets](https://github.com/openstreetmap/mapnik-stylesheets) +* [OpenStreetMap "FR" Carto](https://github.com/cquest/osmfr-cartocss) +* [OpenStreetMap Carto German](https://github.com/giggls/openstreetmap-carto-de) # Maintainers -* Andy Allan [@gravitystorm](https://github.com/gravitystorm/) -* Paul Norman [@pnorman](https://github.com/pnorman/) +* Andy Allan [@gravitystorm](https://github.com/gravitystorm) +* Paul Norman [@pnorman](https://github.com/pnorman) * Daniel Koć [@kocio-pl](https://github.com/kocio-pl) * Christoph Hormann [@imagico](https://github.com/imagico) * Lukas Sommer [@sommerluk](https://github.com/sommerluk) @@ -102,5 +99,5 @@ maps using Mapnik, many based on this project. Some alternatives are: ## Previous maintainers * Michael Glanznig [@nebulon42](https://github.com/nebulon42) -* Matthijs Melissen [@matthijsmelissen](https://github.com/matthijsmelissen/) -* Mateusz Konieczny [@matkoniecz](https://github.com/matkoniecz/) +* Matthijs Melissen [@matthijsmelissen](https://github.com/matthijsmelissen) +* Mateusz Konieczny [@matkoniecz](https://github.com/matkoniecz) From 11a05f7805eb6c5921ba28c8fcc31ca2be5d2a91 Mon Sep 17 00:00:00 2001 From: danieldegroot2 <67521919+danieldegroot2@users.noreply.github.com> Date: Thu, 9 Jun 2022 22:47:31 +0200 Subject: [PATCH 5/9] Upgrade URL --- RELEASES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASES.md b/RELEASES.md index b3ce9b77f5..c99bb1b905 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -6,7 +6,7 @@ Throughout this document, replace $OLD_VERSION with the previous release and $NE 1. Update your local master branch 2. Review the changes in git since the last release with a command like `git log --graph $OLD_VERSION...master` or online at https://github.com/gravitystorm/openstreetmap-carto/compare/$OLD_VERSION...master -3. Review [pull requests](https://github.com/gravitystorm/openstreetmap-carto/pulls) for anything that should be merged before release +3. Review [pull requests](pulls) for anything that should be merged before release 4. Check [`preview.png`](preview.png) and update it if needed. Preferred way is to import current Chicago data, export new image (for example from Kosmtik via [this link](http://127.0.0.1:6789/openstreetmap-carto/export/?showExtent=true&format=png&width=849&height=310&scale=1&zoom=15&bounds=-87.65145778656006%2C41.86914537674214%2C-87.61502265930177%2C41.8790515319021)) and upload as new version of this file Decide among the maintainers if a new release is due. From 47ad08b8cc89a0afb181e984cd843a626536a982 Mon Sep 17 00:00:00 2001 From: danieldegroot2 <67521919+danieldegroot2@users.noreply.github.com> Date: Thu, 9 Jun 2022 23:03:17 +0200 Subject: [PATCH 6/9] Upgrade URLs --- DOCKER.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/DOCKER.md b/DOCKER.md index 0fc7418cf6..0e076e6a8f 100644 --- a/DOCKER.md +++ b/DOCKER.md @@ -1,13 +1,13 @@ # Running OpenStreetMap Carto with Docker -[Docker](https://docker.com) is a virtualized environment running a [_Docker demon_](https://docs.docker.com/engine/docker-overview), in which you can run software without altering your host system permanently. The software components run in _containers_ that are easy to setup and tear down individually. The Docker demon can use operating-system-level virtualization (Linux, Windows) or a virtual machine (macOS, Windows). +[Docker](https://www.docker.com/) is a virtualized environment running a [_Docker demon_](https://docs.docker.com/get-started/overview/), in which you can run software without altering your host system permanently. The software components run in _containers_ that are easy to setup and tear down individually. The Docker demon can use operating-system-level virtualization (Linux, Windows) or a virtual machine (macOS, Windows). This allows to set up a development environment for OpenStreetMap Carto easily. Specifically, this environment consists of a PostgreSQL database to store the OpenStreetMap data and [Kosmtik](https://github.com/kosmtik/kosmtik) for previewing the style. ## Prerequisites -Docker is available for Linux, macOS and Windows. [Install](https://www.docker.com/get-docker) the software packaged for your host system in order +Docker is available for Linux, macOS and Windows. [Install](https://www.docker.com/products/docker-desktop/) the software packaged for your host system in order to be able to run Docker containers. You also need Docker Compose, which should be available once you installed Docker itself. Otherwise you need to [install Docker Compose manually](https://docs.docker.com/compose/install/). @@ -29,7 +29,7 @@ Read on below to get the details. ## Repositories -Instructions above will clone main OpenStreetMap Carto repository. To test your own changes you should [fork](https://help.github.com/articles/fork-a-repo/) gravitystorm/openstreetmap-carto repository and [clone your fork](https://help.github.com/articles/cloning-a-repository/). +Instructions above will clone main OpenStreetMap Carto repository. To test your own changes you should [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) gravitystorm/openstreetmap-carto repository and [clone your fork](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). This OpenStreetMap Carto repository needs to be a directory that is shared between your host system and the Docker virtual machine. Home directories are shared by default; if your repository is in another place you need to add this to the Docker sharing list (e.g. macOS: Docker Preferences > File Sharing; Windows: Docker Settings > Shared Drives). From 44e043fc81fa51739a8acacfae6a7a6f8c2210c8 Mon Sep 17 00:00:00 2001 From: danieldegroot2 <67521919+danieldegroot2@users.noreply.github.com> Date: Fri, 10 Jun 2022 20:55:26 +0200 Subject: [PATCH 7/9] Fix URLs --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d0200500a..54a26707e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,13 +34,13 @@ images might not be sufficient and a demo layer is necessary. pnorman has a serv ## Easy pickings -Some [easy issues](labels/good%20first%20issue) have been selected +Some [easy issues](https://github.com/gravitystorm/openstreetmap-carto/labels/good%20first%20issue) have been selected that are particularly suitable for new contributors to get familiar with the project's code base and the contribution process. ## Editing layers OpenStreetMap Carto uses a YAML file for defining layers, because it [works much -better for big projects](issues/711). +better for big projects](https://github.com/gravitystorm/openstreetmap-carto/issues/711). This requires CartoCSS 0.18.0 or later. If you need JSON MML, you can generate it with `python -c 'import sys, yaml, json; json.dump(yaml.safe_load(sys.stdin), sys.stdout)' < project.mml > project.json` or the equivalent in a different language. From bfb8a7cbfb2b9a27a066bf56ece76b1473213013 Mon Sep 17 00:00:00 2001 From: danieldegroot2 <67521919+danieldegroot2@users.noreply.github.com> Date: Fri, 10 Jun 2022 21:02:12 +0200 Subject: [PATCH 8/9] Fix URL Permalink for mapnik-stylesheets template line, just fyi (the existing link with `master` seems fine). https://github.com/openstreetmap/mapnik-stylesheets/blob/236f8d0ab17b792300679cedf9afa5b0feab301b/inc/settings.xml.inc.template#L16 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a1542d0a37..498342abe8 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ to reload their databases, v3.x compatibility is not maintained. The v5.x series updates Lua tag transforms, linestring and polygon decisions have changed. -There are over [500 open requests](issues), some that have been open for years. +There are over [500 open requests](https://github.com/gravitystorm/openstreetmap-carto/issues), some that have been open for years. These need reviewing and dividing into obvious fixes, or additional new features that need some cartographic judgement. From 7745a7c4a70b08a8f9775838c93fcaff95331c1d Mon Sep 17 00:00:00 2001 From: danieldegroot2 <67521919+danieldegroot2@users.noreply.github.com> Date: Fri, 10 Jun 2022 21:03:47 +0200 Subject: [PATCH 9/9] Fix URL --- RELEASES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASES.md b/RELEASES.md index c99bb1b905..b3ce9b77f5 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -6,7 +6,7 @@ Throughout this document, replace $OLD_VERSION with the previous release and $NE 1. Update your local master branch 2. Review the changes in git since the last release with a command like `git log --graph $OLD_VERSION...master` or online at https://github.com/gravitystorm/openstreetmap-carto/compare/$OLD_VERSION...master -3. Review [pull requests](pulls) for anything that should be merged before release +3. Review [pull requests](https://github.com/gravitystorm/openstreetmap-carto/pulls) for anything that should be merged before release 4. Check [`preview.png`](preview.png) and update it if needed. Preferred way is to import current Chicago data, export new image (for example from Kosmtik via [this link](http://127.0.0.1:6789/openstreetmap-carto/export/?showExtent=true&format=png&width=849&height=310&scale=1&zoom=15&bounds=-87.65145778656006%2C41.86914537674214%2C-87.61502265930177%2C41.8790515319021)) and upload as new version of this file Decide among the maintainers if a new release is due.