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

docs(page): add breaking changes page #4841

Conversation

niklas-wortmann
Copy link
Member

As discussed in #4512 . This pr adds a static page describing the actual bug occured with version 6.4 and how to solve it. It can also be used for any further breaking changes to add some dedicated documentation for it.

closes #4512

The Page actually looks like that:
image

@benlesh
Copy link
Member

benlesh commented Aug 1, 2019

The more I think about this, the more I'm not sure we should do this. The CHANGELOG file should be the source of truth for breaking changes. They've all been documented there. Perhaps we need to be better about going back and updating it when we find something breaking after a release that we can't unbreak, for fear that would break even more people.

@benlesh benlesh added the AGENDA ITEM Flagged for discussion at core team meetings label Aug 1, 2019
@niklas-wortmann
Copy link
Member Author

To sum up yesterday's discussion: I will add the Changelog to the docs as well and we will keep this breaking changes pages as additional information besides the changelog

@niklas-wortmann niklas-wortmann removed the AGENDA ITEM Flagged for discussion at core team meetings label Dec 4, 2019
@niklas-wortmann niklas-wortmann self-assigned this Dec 4, 2019
@benlesh
Copy link
Member

benlesh commented Jun 9, 2020

@niklas-wortmann is this still relevant? Or can it be closed?

@niklas-wortmann
Copy link
Member Author

good call. close in favor of #5426

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 this pull request may close these issues.

Issues with RxJS 6.4.0 and Angular CLI 6.1.x
3 participants