Rename widgets to panels in alignment with dashboards working group
Problem to solve
Product Analytics currently refers to the resizable blocks on a dashboard that contain visualizations as widgets
. The Dashboard working group has agreed that the common nomenclature for these elements should be panels
.
Implementation plan
backend/frontend/documentation -
- Re-rerun the below command to make sure all areas are covered.
- Update all code, specs, UI, translations, and docs to use the term
panel
instead ofwidget
. - During review process keep an eye on any new content that may have been added.
- Announce the change in
#g_analyze_product_analytics
.
Known locations:
Checked using grep "widget" -Ril --exclude-dir=node_modules --exclude-dir=locale --exclude-dir=stylesheets --exclude-dir=work_items --exclude-dir=changelog --exclude-dir=tmp --exclude-dir=.gitlab --exclude-dir=.rubocop_todo --exclude-dir=vue_merge_request_widget --exclude-dir=notes --exclude-dir=pipeline_wizard --exclude-dir=config --exclude-dir=data --exclude-dir=danger --exclude-dir=vendor ./ >> widget_instances.txt
(still contains a lot of false positives, manual checks are required).
./ee/app/models/product_analytics/dashboard.rb
./ee/app/models/product_analytics/widget.rb
./ee/app/graphql/types/product_analytics/dashboard_type.rb
./ee/app/graphql/types/product_analytics/widget_type.rb
./ee/app/validators/json_schemas/product_analytics_dashboard.json
./ee/app/assets/javascripts/product_analytics/dashboards/constants.js
./ee/app/assets/javascripts/product_analytics/dashboards/dashboards_view.vue
./ee/app/assets/javascripts/product_analytics/dashboards/components/analytics_dashboard.vue
./ee/app/assets/javascripts/product_analytics/dashboards/components/analytics_widget_designer.vue
./ee/app/assets/javascripts/product_analytics/dashboards/components/widget_designer/analytics_widget_preview.vue
./ee/app/assets/javascripts/product_analytics/dashboards/gl_dashboards/dashboard_behavior.json
./ee/app/assets/javascripts/product_analytics/dashboards/gl_dashboards/dashboard_audience.json
./ee/app/assets/javascripts/vue_shared/components/customizable_dashboard/customizable_dashboard.vue
./ee/app/assets/javascripts/vue_shared/components/customizable_dashboard/widgets_base.vue
./ee/app/assets/javascripts/vue_shared/components/customizable_dashboard/customizable_dashboard.stories.js
./ee/app/assets/javascripts/vue_shared/components/customizable_dashboard/widgets_base.stories.js
./ee/spec/frontend/product_analytics/dashboards/dashboards_view_spec.js
./ee/spec/frontend/product_analytics/dashboards/components/analytics_widget_designer_spec.js
./ee/spec/frontend/product_analytics/dashboards/components/widget_designer/analytics_cube_query_measure_selector_spec.js
./ee/spec/frontend/product_analytics/dashboards/components/widget_designer/analytics_visualization_inspector_spec.js
./ee/spec/frontend/product_analytics/dashboards/components/widget_designer/analytics_widget_preview_spec.js
./ee/spec/frontend/product_analytics/dashboards/components/widget_designer/analytics_cube_query_dimension_selector_spec.js
./ee/spec/frontend/vue_shared/components/customizable_dashboard/mock_data.js
./ee/spec/frontend/vue_shared/components/customizable_dashboard/customizable_dashboard_spec.js
./ee/spec/frontend/vue_shared/components/customizable_dashboard/widgets_base_spec.js
./ee/spec/models/product_analytics/dashboard_spec.rb
./ee/spec/models/product_analytics/widget_spec.rb
./ee/spec/requests/api/graphql/product_analytics/visualizations_spec.rb
./ee/spec/graphql/resolvers/product_analytics/visualization_resolver_spec.rb
./ee/spec/fixtures/product_analytics/dashboard_example_1.yaml
./doc/development/fe_guide/customizable_dashboards.md
./doc/api/graphql/reference/index.md
Edited by Robert Hunt