Create a generic country requirement design document. #77

Closed
opened 2026-08-09 09:40:18 +00:00 by art · 0 comments
Owner

This would document how a newly imported country should look like. This is in preparation to import a handful of countries we haven't touched before, so I want us to have learned from the mistakes in the imports this far and only do new, fresh mistakes in the new countries.

This can start from how we're doing things today (e.g. a country should have a cover layer which generalizes in a particular way, rivers, lakes, roads, etc.).

But most importantly read through all issues (open and closed) and try to find those that even if they are a bug report for specific countries should apply to all countries. For example:

  • #71 would make sense for all countries. I would even add a stronger requirement to it - if the capital isn't the last one standing when every other name has been generalized away then there's a bug in the generalization, the top 5 names should be the top 5 largest cities.
  • #64 definitely applies to every country.
  • #41 should apply to every country.

Then extract the learning/rule from those issues, generalize it and put it in the document.

The same thing with existing documentation. Some country-specific documentation talks about things that should apply to all, maybe relevant things are mentioned in the style or other documents. Move that documentation from those documents to the new one.

The previous paragrah also applies to comments in the per-country configs, I have seen things that should general rules hidden inside XXmap.yaml.

Then go through each current country and create issues where it doesn't conform (I know of a very specific example, but I will not mention it here, I will use it as a benchmark for how successful this work was).

This would document how a newly imported country should look like. This is in preparation to import a handful of countries we haven't touched before, so I want us to have learned from the mistakes in the imports this far and only do new, fresh mistakes in the new countries. This can start from how we're doing things today (e.g. a country should have a cover layer which generalizes in a particular way, rivers, lakes, roads, etc.). But most importantly read through all issues (open and closed) and try to find those that even if they are a bug report for specific countries should apply to all countries. For example: * #71 would make sense for all countries. I would even add a stronger requirement to it - if the capital isn't the last one standing when every other name has been generalized away then there's a bug in the generalization, the top 5 names should be the top 5 largest cities. * #64 definitely applies to every country. * #41 should apply to every country. Then extract the learning/rule from those issues, generalize it and put it in the document. The same thing with existing documentation. Some country-specific documentation talks about things that should apply to all, maybe relevant things are mentioned in the style or other documents. Move that documentation from those documents to the new one. The previous paragrah also applies to comments in the per-country configs, I have seen things that should general rules hidden inside XXmap.yaml. Then go through each current country and create issues where it doesn't conform (I know of a very specific example, but I will not mention it here, I will use it as a benchmark for how successful this work was).
art closed this issue 2026-08-09 10:46:27 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
art/ismap#77
No description provided.