Skip to content

[proposal] add disputed names #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
May 21, 2025
Merged

[proposal] add disputed names #319

merged 10 commits into from
May 21, 2025

Conversation

jonahadkins
Copy link
Contributor

Category

What kind of change is this?

Please select one of the following five options.

Consult Pull request merging criteria for a description of each category.

  1. MAJOR schema change as defined in Schema versioning and stability.
  2. MINOR schema change as defined in Schema versioning and stability.
  3. Cosmetic change.
  4. Documentation change by member.
  5. Documentation change by Overture tech writer.

Major change release plan

TODO: For any non-MAJOR change, delete this whole section.

For a MAJOR change as defined in Schema versioning and stability,
indicate the expected release date, related minor change steps, and your
public documentation and messaging plan.

A. Expected release date for this MAJOR change

TODO.

B. Related MINOR change steps

  • TODO. List each related MINOR change as a bullet.

C. Public documentation and messaging lan

TODO.

Description

Perspectives for Geographic Features

We are all familiar with disputes and perspectives as a function of dealing with administrative names and borders. There also exist complex perspectives over geographic features. Common examples that our users may need to support are the Sea of Japan and the Falkland Islands.

This PR proposes the following changes:

  • adds is_disputed to the base theme to flag features like mountain points, polygonal water bodies, polygonal land bodies, etc. that may contain disputed name
  • adds perspectives to the base theme, when used in conjunction with is_disputed this allows users to create the proper perspective view.
  • adds disputed as a valid value to the rules for names. Disputed names may be a separate thing from the common or official names.

TODO.

Reference

List of relevant links to GitHub issues, PRs, and other documentation.

  1. TODO.

Testing

Brief description of the testing done for this change showing why you are confident it works as expected and does not introduce regressions. Provide sample output data where appropriate.

TODO.

Checklist

Checklist of tasks commonly-associated with schema pull requests. Please review the relevant checklists and ensure you do all the tasks that are required for the change you made.

  1. Add relevant examples.
  2. Add relevant counterexamples.
  3. Update any counterexamples that became obsolete. For example, if a counterexample uses property A but is not intended to test property A's validity, and you made a schema change that invalidates property A in that counterexample, fix the counterexample to align it with your schema change.
  4. Update in-schema documentation using plain English written in complete sentences, if an update is required.
  5. Update Docusaurus documentation, if an update is required.
  6. Review change with Overture technical writer to ensure any advanced documentation needs will be taken care of, unless the change is trivial and would not affect the documentation.

Documentation Website

Update the hyperlink below to put the pull request number in.

[Docs preview for this PR.](https://dfhx9f55j8eg5.cloudfront.net/pr/<PUT THE PR # HERE>)

@jonahadkins jonahadkins added change type - minor 🤏 Minor schema change. See https://lf-overturemaps.atlassian.net/wiki/x/GgDa change type - cosmetic 🌹 Cosmetic change labels Jan 31, 2025
@jonahadkins jonahadkins force-pushed the jonahadkins-base-perspectives branch from 2c54388 to 7cc9cbc Compare April 23, 2025 12:56
@jonahadkins jonahadkins changed the title [proposal] add perspectives to base theme [proposal] add disputed names Apr 23, 2025
@jonahadkins jonahadkins removed the change type - cosmetic 🌹 Cosmetic change label Apr 23, 2025
@jonahadkins
Copy link
Contributor Author

jonahadkins commented Apr 23, 2025

here's a formatted example to use for feedback

  names:
    primary: Golfo de México
    common:
      en: Gulf of Mexico
      fr: Golfe du Mexique
      es: Golfo de México
      zh: 墨西哥湾
    rules:
      - variant: official
        accepted_by: US
        value: Gulf of America
      - variant: official
        disputed_by: MX
        value: Gulf of Mexico

DavidKarlas
DavidKarlas previously approved these changes May 7, 2025
vcschapp
vcschapp previously approved these changes May 7, 2025
vcschapp added a commit to vcschapp/overture-schema-linkml that referenced this pull request May 7, 2025
This change does not include the proposed schema support for disputed
names: OvertureMaps/schema#319

One issue I discovered during this commit: LinkML's JSON Schema
generator gets confused by indirection. I filed bug #2666 to the LinkML
repo for this: linkml/linkml#2666
Copy link
Collaborator

@vcschapp vcschapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonahadkins one thing I forgot if we discussed in all the back-and-forth: are we going to populate names perspectives with data for any features?

It would be good if the real life Gulf of Cartographer's Tears and Mount McTearly actually receive the names perspectives as a result of our data pipeline populating them correctly.

@vcschapp
Copy link
Collaborator

This is fully approved up. Merging.

@vcschapp vcschapp merged commit d55f6d4 into dev May 21, 2025
3 checks passed
@vcschapp vcschapp deleted the jonahadkins-base-perspectives branch May 21, 2025 14:28
vcschapp added a commit to vcschapp/overture-schema-linkml that referenced this pull request May 23, 2025
This commit applies the changes Jonah recently merged into the Overture
schema in PR #319.

OvertureMaps/schema#319

As modeled in this commit, all the perspectives models should be
directly reusable for divisions when I get around to modeling that.

(Which reminds me that one issue with Jonah's PR is that we reviewers
totally failed to push for type reusability so there's duplication.)

One revelation I had while modeling is that the way we do perspectives
is essentially a form of scoping property. That's very interesting.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change type - minor 🤏 Minor schema change. See https://lf-overturemaps.atlassian.net/wiki/x/GgDa
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants