Skip to content
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

Prepare Changlelog for 1.8.0 #8021

Closed
Falke-Design opened this issue Feb 24, 2022 · 16 comments
Closed

Prepare Changlelog for 1.8.0 #8021

Falke-Design opened this issue Feb 24, 2022 · 16 comments
Milestone

Comments

@Falke-Design
Copy link
Member

Falke-Design commented Feb 24, 2022

Breaking Changes

  • Refactor TapHold handler to simulate contextmenu event on mobile Safari (#7026 by @johnd0e)
  • Refactor DivOverlay/Popup/Tooltip (#7540 by @johnd0e)
  • Improve error / argument handling for event listeners (#7518 by @johnd0e)
  • Refactor DomEvent.Pointer which simulates touchevents on non-touch devices (#7059, #7084, #7415 by @johnd0e)
  • Refactor DomEvent.DoubleTap which simulates dblclick event in not supported Browsers (#7027 by @johnd0e)
  • Refactor disableClickPropagation (#7439 by @johnd0e)
  • Map.hasLayer() and LayerGroup.hasLayer() now requires a layer as argument (#6999 by @johnd0e)
  • Class.include keep options (#7756 by @johnd0e)
  • Avoid modifying source props object in Class.extend (#6766 by @johnd0e)
  • Correct Browser.touch (#7029 by @johnd0e)
  • Get rid of android legacy hacks (#7022 by @johnd0e)

API changes

Improvements

  • Avoid excessive _update() call in GridLayer.onAdd (#7570 by @johnd0e)
  • Update panInside calculation (#7469 by @daverayment)
  • TileLayer allow template keys with spaces in URL (#7216 by @lubojr)
  • Tooltips can now bound to ImageOverlays because it can rely on parent layer getBounds() (#7306 by @IvanSanchez)
  • Remove gap between Popup tip and content dialog (#7920 by @Malvoz)
  • Fire mousemove through Canvas to map if it has no layers (#7809 by @johnd0e)
  • Replace div with span in Control.Layers container to fix an HTML validation error (#7914 by @tmiaa)
  • Improve memory footprint by removing will-change CSS property on tile images (#7872 by @janjaap)
  • Better icon image path detection (#7092 by @johnd0e)
  • Makes Browser mutable (#7335 by @bozdoz)
  • Add print styles to prevent printers from removing background-images in controls (#7851 by @Malvoz)
  • Move attribution code from Layer to Control.Attribution (#7764 by @johnd0e)
  • Minifiy marker icon svg (#7600 by @rala72)
  • Refactor vmlCreate() so that it does not expose closure to TypeError (#7279 by @darcyparker)
  • Control.Layers stop relying on Browser android and touch properties (#7057 by @johnd0e)
  • Tooltip remove Browser touch checks (#7535 by @johnd0e)
  • Converte Plugins.md to single files (#7805 by @Falke-Design)
  • Remove all references of Bower (#7831 by @jonkoops)

Accessibility

  • Add accessibility section to plugins guide (#7277 by @Malvoz)
  • Auto pan to markers on focus by default for improved keyboard operability (#8042 by @IvanSanchez)
  • Update Marker to default to role="button" & alt="marker" for an improved screen reader experience (#7895 by @tmiaa)
  • Set role="button" for appropriate semantics on the <a> layers control (#7850 by @Malvoz)
  • Generally enable outlines for keyboard users by not stripping outline on focus for keyboard events (#7259 by @jafin)
  • Enable outlines on leaflet-container for keyboard users (#7996 by @Malvoz)
  • Multiple enhancements to popup's close button (#7794 by @Falke-Design)
  • Use relative font-size units for resizable text (#7800 by @Chandu-4444)
  • Apply :hover styles to :focus as well (#7274 by @Malvoz)
  • Hide the decorative attribution separator from screen readers (#7969 by @Malvoz)
  • Make the disabled state of zoom controls available to screen readers (#7280 by @akshataj96)
  • Hide the +/- characters in zoom controls from screen readers to prevent erroneous announcements (#7795 by @Falke-Design)

Docs

Update API Docu:

Bug fixes

Plugins

Workflow

Tests

@Falke-Design Falke-Design added this to the 1.8.0 milestone Feb 24, 2022
@Falke-Design
Copy link
Member Author

@mourner @Malvoz @IvanSanchez @jonkoops this are all commits since 1.7.1 I sorted them by category but now they need a deeper check and a better describtion, help is welcome. I suggest to simply edit the main post and add ✔️ to the commit.
Many commits are follow ups from one Feature / Bug or to revert some changes. So we need to check which commits are releated to the same topic and merge them together.

The biggest changes in this release are:

Also I would like to add a thank you for @johnd0e to the Release notes. He refactored the touch events and DivOverlay without much help. Maybe I'm wrong but in my eyes kept @johnd0e Leaflet alive until we get a fresh wind in November.

@jonkoops
Copy link
Collaborator

Thanks @Falke-Design, much appreciated. I don't think I will have much time in the coming weeks, but I will try to see if I can walk through some of them. Unfortunately with the invasion of Ukraine I think @mourner has other priorities at the moment, so we'll have to get this done with the rest of the team.

@Falke-Design
Copy link
Member Author

Yes I think too, but I still wanted to inform him even though he wont see it.

I already made the first points and it wasn't that much work for me. So if you don't have time, let me do it, is no problem ;)

@Falke-Design
Copy link
Member Author

@jonkoops @Malvoz @IvanSanchez can you please make a quick check over the Changelog. From my side it is ready for the Release.
And can please someone of you prepare a Blog post? I'm sure you already noticed that my english is not always the best 😉
It would be good to inlcude in the blog post following:

Please response if you can do the blog post or not.

@Malvoz
Copy link
Member

Malvoz commented Feb 27, 2022

Thanks for doing all this work @Falke-Design! I'm a bit busy atm but a couple of notes:

  • Accessibility changes

#7851 probably does not belong to that list, since it's just a small UX improvement for printed maps.

Add fallbacks to font-size (#7800 by @Chandu-4444)

I think the title of this item can be renamed "Use relative font-size units for resizable text".

Edit: Fixed!

@mourner
Copy link
Member

mourner commented Mar 5, 2022

Thanks so much for taking on this huge task @Falke-Design! I haven't read this through carefully, but several improvement tips I usually use when writing changelogs:

  • Sort everything from most important to least important. For categories, it should roughly be 1) Breaking changes, 2) Features & Improvements, 3) Bugfixes, 4) Everything else. Within each category, also sort from most impactful to least.
  • Where possible, reword changes to reflect impact on the user rather than underlying change. E.g. not "Remove will-change", but rather "Improve memory footprint by removing will-change CSS property on tile images".
  • Edit for consistency — e.g. same form ( ...), capitalized, etc.
  • Omit trivial changes (e.g. typo fixes) where appropriate.

@mourner
Copy link
Member

mourner commented Mar 5, 2022

Once the changelog is ready, I think we can simply tag a new version and do a release. Given the huge number of changes, we could first do a v1.8.0-beta.1, ask people to test it out, and then do a final a week later.

@mourner
Copy link
Member

mourner commented Mar 8, 2022

@Falke-Design let me know when you think the changelog is ready for publishing.

@mourner
Copy link
Member

mourner commented Mar 8, 2022

@IvanSanchez maybe you can have a quick editing run on it when you have a chance. We can create a "draft" release in the GitHub Releases section to quickly edit the changelog for convenience.

@Falke-Design
Copy link
Member Author

I will finish it in the next days. My biggest problem will be reword changes to reflect impact on the user. I will reword them to show the impact on the user but I think someone has to go over it, to make the sentences grammitcal correct 😄

@Malvoz
Copy link
Member

Malvoz commented Mar 8, 2022

I've resolved #8021 (comment), and #8021 (comment):

E.g. not "Remove will-change", but rather "Improve memory footprint by removing will-change CSS property on tile images"

(only that item specifically)

and also turned the generic "Accessibility changes" list item with 10 or so items to individual list items with descriptions.

@Falke-Design
Copy link
Member Author

Very nice! I want to change some small things in the next 2 hours and then we are ready 👍

@Falke-Design
Copy link
Member Author

@mourner ready! 🎉
Should we remove the Plugins section?

@Malvoz
Copy link
Member

Malvoz commented Mar 9, 2022

@Falke-Design I've made many small changes, to reword a few descriptions and to roughly "Sort everything from most important to least important" per #8021 (comment), almost all of my edits are to the Accessibility section.

Also added some of the latest PRs that have been merged.

Should we remove the Plugins section?

I think so. It looks like there are only about 10 "plugin" entries in CHANGELOG.md and they're regarding breaking changes that affect plugins and otherwise compatibility, not regular additions/updates.

@mourner
Copy link
Member

mourner commented Mar 9, 2022

Fantastic work everyone! Making an edit pass now, please stand by.

@mourner
Copy link
Member

mourner commented Mar 9, 2022

You can find the edited v1.8.0 changelog here — let's follow up with any edits in GitHub Releases section from now on: https://github.com/Leaflet/Leaflet/releases/tag/v1.8.0-beta.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants