[Bug] Missing info in upgrade guide
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 8.5k
- Forks
- 1.4k
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 3
Description
Description
Using the upgrade guide "Upgrading to v8.0" was not as smooth as expected
- "mapbox-gl": "^2.15.0",
- "react-map-gl": "^7.1.6" to 8.0.4
I had to do these changes besides changing to use react-map-gl/mapbox-legacy
MapLayerMouseEvent -> MapMouseEvent,
MapboxMap -> MapInstance
MapboxGeoJSONFeature -> MapGeoJSONFeature,
LayerProps no longer have metadata field for type 'custom'
Expected Behavior
I expected the above info to be in the upgrade guide
Steps to Reproduce
Read https://visgl.github.io/react-map-gl/docs/upgrade-guide#upgrading-to-v80
Environment
- Map library:"mapbox-gl": "^2.15.0",
- Map library:"react-map-gl": "^7.1.6" to 8.0.4
- OS: Windows
Logs
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the upgrade guide at https://visgl.github.io/react-map-gl/docs/upgrade-guide#upgrading-to-v80 and compare its migration notes with the changes reported here. Update the guide to cover the event and type renames, the custom LayerProps metadata change, and the react-map-gl/mapbox-legacy transition; done means these migration steps are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100