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 in changelog all widget URLs API changes #10831

Closed
mattab opened this issue Nov 3, 2016 · 4 comments · Fixed by #10872
Closed

Document in changelog all widget URLs API changes #10831

mattab opened this issue Nov 3, 2016 · 4 comments · Fixed by #10872
Assignees
Milestone

Comments

@mattab
Copy link
Member

mattab commented Nov 3, 2016

from #10815

Reasoning behind requesting a partial revert:

  • cannot remember why we marked we would remove those calls
  • Removing them would cause some errors in the way users may embed these reports in their app, forcing them to change apps or products or apps, which is time consuming for them
  • there is no advantage for the platform to remove this code: this is very little code with no complexity and most is tested...
@mattab mattab added this to the 3.0.0-b3 milestone Nov 3, 2016
@sgiehl
Copy link
Member

sgiehl commented Nov 3, 2016

Imho there is not much value in keeping that forever and it would be accaptable if some user may need to change the emedded urls. The plugin was deprecated in 2.10.0 over a year ago.
If we remove them, we should do it with a major release and I wouldn't wait for 4.0.

@mattab
Copy link
Member Author

mattab commented Nov 14, 2016

@sgiehl +1 to remove them but then could we note again in the developer changelog the methods removed and the new methods to use instead.

@mattab mattab modified the milestones: 3.0.0-b4, 3.0.0-b3 Nov 14, 2016
@sgiehl
Copy link
Member

sgiehl commented Nov 14, 2016

I'd add something like:

Widgets using the already removed UserSettings plugin won't work any longer. Please recreate your widget urls using DevicesDetection, Resolution or DevicePlugins plugin instead.

But should we really list all methods that had been removed a long time ago?

@mattab
Copy link
Member Author

mattab commented Nov 15, 2016

But should we really list all methods that had been removed a long time ago?

Yes let's list them all, as the Widget URL embed API was effectively broken it's important I feel to lay out changes we made. Ideally we'd just have to "Copy paste" the previous changelog entries where we would announce the 'url rewrites', but seems we didn't document it so far, so it will be the first time we document.

mattab added a commit that referenced this issue Nov 15, 2016
@mattab mattab changed the title Revert removing Request.getRenamedModuleAndAction listeners Document in changelog all widget URLs API changes Nov 15, 2016
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

Successfully merging a pull request may close this issue.

2 participants