Skip to content

Conversation

@brad-richardson
Copy link
Contributor

@brad-richardson brad-richardson commented Oct 2, 2024

Category

What kind of change is this?
Please select one of the following four options.
Consult Pull request merging criteria for a description of each category.

  1. Cosmetic change.
  2. Documentation change by member.
  3. Documentation change by Overture tech writer.
  4. Material change.

Description

One of transportation's goals for GA is that there are no "trust violations" in the schema or data. As of today, lanes exist in the schema but aren't populated with data in our releases, which isn't documented anywhere and is a poor experience for would-be adopters of our data. There are several options for handling this, but the current members of transportation have decided to remove lanes as they are a low priority and we lack member use cases to do real-world testing of this schema.

We are "re-proposing" lanes in a separate pull request to gather feedback and possibly provide a sidecar for others to experiment with this data at some point in the future.

We plan to enact this removal in the November release, with notice via release notes and a blog post for the October release.

Reference

  1. https://github.com/OvertureMaps/tf-transportation/issues/129
  2. https://github.com/OvertureMaps/tf-transportation/issues/387
  3. [on hold] Lanes #287

Testing

Ran tests, complete removal of attribute

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

Docs preview for this PR.

ibnt1
ibnt1 previously approved these changes Oct 2, 2024
@vbogdana
Copy link

vbogdana commented Oct 4, 2024

Hi @brad-richardson , what is the reasoning behind not populating lanes data in the first place? Afaik, OSM is providing lanes information. I see there is a PR to repropose lanes definition in the schema. Is the plan to populate lanes in the future and we want to revisit the schema decisions? Thanks!

@brad-richardson
Copy link
Contributor Author

Hi @brad-richardson , what is the reasoning behind not populating lanes data in the first place? Afaik, OSM is providing lanes information. I see there is a PR to repropose lanes definition in the schema. Is the plan to populate lanes in the future and we want to revisit the schema decisions? Thanks!

Great questions @vbogdana. The data definitely exists in OSM, we just haven't had anyone "champion"/implement the needed pipeline code and ensure the schema works for at least one actual production implementation. The core issue is that we don't want to ship a dataset with an empty column for GA, as that's a poor developer experience.

@danabauer danabauer requested a review from ibnt1 November 6, 2024 16:44
@danabauer danabauer requested a review from mojodna November 8, 2024 16:56
@jenningsanderson jenningsanderson merged commit 5b33a02 into dev Nov 8, 2024
@jenningsanderson jenningsanderson deleted the remove-lanes branch November 8, 2024 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants