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

[Vislib XY axis] Adds a deprecation notice in the UI and a docs section #105055

Merged
merged 15 commits into from
Jul 20, 2021

Conversation

stratoula
Copy link
Contributor

@stratoula stratoula commented Jul 9, 2021

Summary

It adds a notification on the vislib XY axis charts. The notification is only visible on the editor and not on the dashboard.

Part of #103209

Documentation preview https://kibana_105055.docs-preview.app.elstc.co/guide/en/kibana/master/add-aggregation-based-visualization-panels.html#new-charts-library

image

image

Checklist

Delete any items that are not applicable to this PR.

import {
SavedVisInstance,
VisualizeAppState,
VisualizeAppStateContainer,
VisualizeEditorVisInstance,
} from '../types';
import { getUISettings } from '../../services';

const LEGACY_CHARTS_LIBRARY = 'visualization:visualize:legacyChartsLibrary';
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't import it from xy plugin because it creates a cyclic dependency. As this code and setting is going to removed in the next minor, I think it is ok.

@stratoula
Copy link
Contributor Author

@elasticmachine merge upstream

@stratoula
Copy link
Contributor Author

@elasticmachine merge upstream

@stratoula stratoula added Feature:XYAxis XY-Axis charts (bar, area, line) v7.15.0 v8.0.0 release_note:enhancement docs Team:Visualizations Visualization editors, elastic-charts and infrastructure labels Jul 12, 2021
@stratoula stratoula marked this pull request as ready for review July 12, 2021 13:07
@stratoula stratoula requested a review from a team July 12, 2021 13:07
@stratoula stratoula requested a review from a team as a code owner July 12, 2021 13:07
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app (Team:KibanaApp)

@stratoula
Copy link
Contributor Author

@gchaps @KOTungseth I need your help on this.
I added a notification on the vislib XY axis charts, that are going to be removed in 7.16. I want to inform the users about the removal and suggest them to turn the setting off (if they are still using the old implementation)
If they don't do it, on 7.16 they will automatically switch to the new implementation.

Moreover, I added some documentation explaining the advantages of the new implementation. I would love your feedback on the UI text and the documentation added.

@stratoula stratoula added this to In progress in Legacy visualizations via automation Jul 12, 2021
@stratoula
Copy link
Contributor Author

stratoula commented Jul 13, 2021

@wylieconlon @gchaps
I applied Wylie's comments but I would like to also inform the users who don't have the permissions to edit the advanced settings.(This also agrees with our documentation for vislib deprecation) I know that the text needs refinement so I would like your feedback here.

User has the permissions. I have added one link to the advanced settings switch and one to our documentation.
image

User without permissions. Only link to the documentation and a message to contact the administrator.
image

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
@stratoula
Copy link
Contributor Author

@elasticmachine merge upstream

@stratoula
Copy link
Contributor Author

@gchaps and @KOTungseth thank you! It is much better now! I removed all the changes I made on the aggregation-based section and moved them as Gail suggested on the advanced settings page.

Here are the screenshots of the UI notification:

image

image

@stratoula
Copy link
Contributor Author

@elasticmachine merge upstream

Copy link
Contributor

@wylieconlon wylieconlon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't run the code, but changes LGTM.

@gchaps
Copy link
Contributor

gchaps commented Jul 19, 2021

Re: the warning, since Advanced Settings is a feature, it should use title case.

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
visualize 79 80 +1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
visualize 92.0KB 94.0KB +2.1KB

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@stratoula stratoula merged commit 8b2ceae into elastic:master Jul 20, 2021
Legacy visualizations automation moved this from In progress to Done Jul 20, 2021
stratoula added a commit to stratoula/kibana that referenced this pull request Jul 20, 2021
…on (elastic#105055)

* [Vislib XY axis] Adds a deprecation notice in the UI and a docs section

* Remove cyclic dependency

* Fix link

* Add functional test

* fix functional tests

* Apply PR comments

* Update docs/user/dashboard/aggregation-based.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Apply PR changes

* minor

* Change the implementation

* Use title calse in Advanced Settings

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
stratoula added a commit that referenced this pull request Jul 20, 2021
…on (#105055) (#106221)

* [Vislib XY axis] Adds a deprecation notice in the UI and a docs section

* Remove cyclic dependency

* Fix link

* Add functional test

* fix functional tests

* Apply PR comments

* Update docs/user/dashboard/aggregation-based.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Apply PR changes

* minor

* Change the implementation

* Use title calse in Advanced Settings

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Feature:XYAxis XY-Axis charts (bar, area, line) release_note:enhancement Team:Visualizations Visualization editors, elastic-charts and infrastructure v7.15.0 v8.0.0
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

7 participants