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

Document fallback image change to header in 4.0 release notes #2360

Closed
1 task
Tracked by #2274
hannalaakso opened this issue Sep 23, 2021 · 1 comment
Closed
1 task
Tracked by #2274

Document fallback image change to header in 4.0 release notes #2360

hannalaakso opened this issue Sep 23, 2021 · 1 comment
Assignees
Labels
documentation User requests new documentation or improvements to existing documentation header
Milestone

Comments

@hannalaakso
Copy link
Member

hannalaakso commented Sep 23, 2021

What

We made a markup change to the header in #2229 to fix a blank data URI from triggering a CSP error.

We would have initially considered this work to form part of #2340, but we should actually considering documenting this in our release notes for 4.0 as a breaking change for users of the HTML version of the header.

Why

The reason it should be fast tracked ahead of #2340 is that:

  • it fixes a potential CSP error
  • the <image> tag which the change removes is being flagged by markup validators as deprecated

Who needs to know about this

Developers; Tech Writer

Done when

  • We have added the markup change to the 4.0 release notes as a breaking change for users of the HTML version of the header component
@hannalaakso hannalaakso added this to the v4.0.0 milestone Sep 23, 2021
@hannalaakso hannalaakso added the documentation User requests new documentation or improvements to existing documentation label Sep 23, 2021
@36degrees
Copy link
Contributor

Having caught up with Eoin, I'm going to close this as it's very likely that we're going to need to ask users to make changes to the header markup as a result of #1739. If we included both things as discrete entries in the release notes, both would touch the same lines of code and would need to be made in a certain order.

Instead, I'll add a note to that issue to make sure that we consider this when writing the release notes for that – ensuring that the release notes work whether users have made the changes in #2229 or not, and that we prompt them to do so if not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User requests new documentation or improvements to existing documentation header
Projects
None yet
Development

No branches or pull requests

3 participants