AF-1680: Add a Release Note entry about the Chart Library change #1538
Conversation
|
When the ticket AF-1680 was created GCharts was not marked for removal, hence why I would do a more detailed description about the libraries etc. Since GCharts will be removed (see https://issues.jboss.org/browse/AF-1774 )I think that a single Release Note is required to inform community users that GCharts will not be there in next release. |
|
|
||
| == New Chart API | ||
|
|
||
| Business Central uses a new API for charts rendering based on C3 and D3. The C3 Renderer API is used by default, now it implements all the features from the legacy chart library, GCharts, consequently GCharts is marked as deprecated and should be removed in later releases. To switch back to Google Charts you can use the system property `org.dashbuilder.renderer.default`, which should have the ID of the renderer you want to use by default. The possible values for Business Central are *gwtcharts* or *c3*, so to switch back to google use the system property `org.dashbuilder.renderer.default=gwtcharts` |
There was a problem hiding this comment.
@jesuino, I suggest the following. Should someone else on the AppFormer team validate this note? Typically every PR should have both an SME and writer peer reviewer.
== New chart API for {CENTRAL}
{CENTRAL} uses a new API for chart rendering based on C3 and D3. The C3 Renderer API is used by default and implements all of the features from the previous chart library, Google Charts. The Google Charts library is now deprecated and will be removed in a future release. To revert to Google Charts, you can set the renderer system property to `org.dashbuilder.renderer.default=gwtcharts`.
There was a problem hiding this comment.
@jesuino, just reminding you about this. An SME reviewer should also approve, per standard process with kie-docs PRs.
There was a problem hiding this comment.
@sterobin Hello Stetson, I was waiting for a decision about what would be done with google charts renderer to update this doc. I will update it soon and ask a SME reviewer to approve this. Thanks.
…GChart removal in future release
|
Hello @paulovmr - would you please review my documentation change? I also added a |
|
Hi @sterobin , could you please take a look? Thanks! |
|
Hello @sterobin I made the changes you requested. I also added a note in the dasboards section as requested by @ederign in kiegroup/appformer#705 Thanks and sorry for the confusion. |
| @@ -0,0 +1,7 @@ | |||
| [[_jbpmreleasenotes72201]] | |||
|
|
|||
| == New chart API for {CENTRAL} | |||
There was a problem hiding this comment.
@jesuino, you said you implemented my rewrite, but I don't see that you have completely. Still grammatical issues throughout. So to clarify, please use this entire rewrite below for this release note, which also now includes the bit that you added. If there is anything in this rewrite that is incorrect or that you disagree with, adjust as you see fit.
== New chart API for {CENTRAL}
{CENTRAL} uses a new API for chart rendering based on C3 and D3. The C3 Renderer API is used by default and implements all of the features from the previous chart library, Google Charts. The Google Charts library is now deprecated and will be removed in a future release. To revert to Google Charts, build it from sources and add it to {CENTRAL} (see the `README.md` file in `dashbuilder-renderer-google`), and then set the renderer system property to `org.dashbuilder.renderer.default=gwtcharts`.
|
|
||
| [NOTE] | ||
| ==== | ||
| By default Dashboards using C3/D3 libraries and Google Charts is deprecated and removed from default distribution. To switch back to Google Charts you have to build it from sources and add it to {CENTRAL} (see `README.md` in `dashbuilder-renderer-google`), then you can use the system property `org.dashbuilder.renderer.default`, which should have the ID of the renderer you want to use by default. For google charts you should use `org.dashbuilder.renderer.default=gwtcharts`. |
There was a problem hiding this comment.
Suggested rewrite, for clarity and consistency with the rewritten release note. Feel free to correct anything that is incorrect.
[NOTE]
====
By default, {CENTRAL} uses a C3 Renderer API for chart libraries and no longer uses the Google Charts library. To revert to Google Charts, build it from sources and add it to {CENTRAL} (see the `README.md` file in `dashbuilder-renderer-google`), and then set the renderer system property to `org.dashbuilder.renderer.default=gwtcharts`.
====
|
@sterobin I hope this is correct now, let me know if I am missing anything, thanks! |
…che#1538) * AF-1680: Add a Release Note entry about the Chart Library change and GChart removal in future release * AF-1680: Updating Release Notes for jBPM 7.22.0 * AF-1680: Updating Release Notes and adding a note about the charts library change * AF-1680: Improving note and release note
Add a Release Note entry about the Chart Library change and GChart removal in future release.