diff --git a/README.md b/README.md index 965e86ae..d7627eb8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ # OpenSearch Dashboards Reports -OpenSearch Dashboards Reports allows ‘Report Owner’ (engineers, including but not limited to developers, DevOps, IT Engineer, and IT admin) export and share reports from OpenSearch Dashboards dashboards, saved search, alerts and visualizations. It helps automate the process of scheduling reports on an on-demand or a periodical basis (on cron schedules as well). Further, it also automates the process of exporting and sharing reports triggered for various alerts. The feature is present in the Dashboard, Discover, and Visualization tabs. Scheduled reports can be sent to (shared with) self or various stakeholders within the organization such as, including but not limited to, executives, managers, engineers (developers, DevOps, IT Engineer) in the form of pdf, hyperlinks, csv, excel via various channels such as email, slack, Amazon Chime. However, in order to export, schedule and share reports, report owners should have the necessary permissions as defined under Roles and Privileges. +OpenSearch Dashboards Reports allows ‘Report Owner’ (engineers, including but not limited to developers, DevOps, IT Engineer, and IT admin) export and share reports from OpenSearch Dashboards dashboards, saved search, alerts and visualizations. It helps automate the process of scheduling reports on an on-demand or a periodical basis (on cron schedules as well). Further, it also automates the process of exporting and sharing reports triggered for various alerts. The feature is present in the Dashboard, Discover, and Visualization tabs. We are currently working on integrating Dashboards Reports with Notifications to enable sharing functionality. After the support is introduced, scheduled reports can be sent to (shared with) self or various stakeholders within the organization. These stakeholders include but are not limited to, executives, managers, engineers (developers, DevOps, IT Engineer) in the form of pdf, hyperlinks, csv, excel via various channels such as email, Slack, and Amazon Chime. However, in order to export, schedule and share reports, report owners should have the necessary permissions as defined under Roles and Privileges. # Request for Comments ( RFC ) @@ -33,6 +33,10 @@ There could be two reasons for this problem We welcome you to get involved in development, documentation, testing the OpenSearch Dashboards reports plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in. +## Notifications Integration + +OpenSearch Dashboards Reports integration with [Notifications](https://github.com/opensearch-project/notifications) is currently in progress, tracking for the 8/30 OpenSearch 1.1 release. + ## Code of Conduct This project has adopted an [Open Source Code of Conduct](https://opensearch.org/codeofconduct.html). diff --git a/dashboards-reports/docs/dev/OpenSearch-Dashboards-Reporting-Design-Proposal.md b/docs/dashboards-reports/dev/OpenSearch-Dashboards-Reporting-Design-Proposal.md similarity index 100% rename from dashboards-reports/docs/dev/OpenSearch-Dashboards-Reporting-Design-Proposal.md rename to docs/dashboards-reports/dev/OpenSearch-Dashboards-Reporting-Design-Proposal.md diff --git a/dashboards-reports/docs/dev/img/SQL_query_report.png b/docs/dashboards-reports/dev/img/SQL_query_report.png similarity index 100% rename from dashboards-reports/docs/dev/img/SQL_query_report.png rename to docs/dashboards-reports/dev/img/SQL_query_report.png diff --git a/dashboards-reports/docs/dev/img/arch_1.png b/docs/dashboards-reports/dev/img/arch_1.png similarity index 100% rename from dashboards-reports/docs/dev/img/arch_1.png rename to docs/dashboards-reports/dev/img/arch_1.png diff --git a/dashboards-reports/docs/dev/img/arch_2.png b/docs/dashboards-reports/dev/img/arch_2.png similarity index 100% rename from dashboards-reports/docs/dev/img/arch_2.png rename to docs/dashboards-reports/dev/img/arch_2.png diff --git a/dashboards-reports/docs/dev/img/arch_3.png b/docs/dashboards-reports/dev/img/arch_3.png similarity index 100% rename from dashboards-reports/docs/dev/img/arch_3.png rename to docs/dashboards-reports/dev/img/arch_3.png diff --git a/dashboards-reports/docs/dev/img/dashboard_reports.png b/docs/dashboards-reports/dev/img/dashboard_reports.png similarity index 100% rename from dashboards-reports/docs/dev/img/dashboard_reports.png rename to docs/dashboards-reports/dev/img/dashboard_reports.png diff --git a/dashboards-reports/docs/dev/img/data_model.png b/docs/dashboards-reports/dev/img/data_model.png similarity index 100% rename from dashboards-reports/docs/dev/img/data_model.png rename to docs/dashboards-reports/dev/img/data_model.png diff --git a/dashboards-reports/docs/dev/img/delivery.png b/docs/dashboards-reports/dev/img/delivery.png similarity index 100% rename from dashboards-reports/docs/dev/img/delivery.png rename to docs/dashboards-reports/dev/img/delivery.png diff --git a/dashboards-reports/docs/dev/img/matrix.png b/docs/dashboards-reports/dev/img/matrix.png similarity index 100% rename from dashboards-reports/docs/dev/img/matrix.png rename to docs/dashboards-reports/dev/img/matrix.png diff --git a/dashboards-reports/docs/dev/img/workflows.png b/docs/dashboards-reports/dev/img/workflows.png similarity index 100% rename from dashboards-reports/docs/dev/img/workflows.png rename to docs/dashboards-reports/dev/img/workflows.png diff --git a/dashboards-reports/docs/dev/resources/SQL_query_report.drawio b/docs/dashboards-reports/dev/resources/SQL_query_report.drawio similarity index 100% rename from dashboards-reports/docs/dev/resources/SQL_query_report.drawio rename to docs/dashboards-reports/dev/resources/SQL_query_report.drawio diff --git a/dashboards-reports/docs/dev/resources/arch_1.drawio b/docs/dashboards-reports/dev/resources/arch_1.drawio similarity index 100% rename from dashboards-reports/docs/dev/resources/arch_1.drawio rename to docs/dashboards-reports/dev/resources/arch_1.drawio diff --git a/dashboards-reports/docs/dev/resources/arch_2.drawio b/docs/dashboards-reports/dev/resources/arch_2.drawio similarity index 100% rename from dashboards-reports/docs/dev/resources/arch_2.drawio rename to docs/dashboards-reports/dev/resources/arch_2.drawio diff --git a/dashboards-reports/docs/dev/resources/arch_3.drawio b/docs/dashboards-reports/dev/resources/arch_3.drawio similarity index 100% rename from dashboards-reports/docs/dev/resources/arch_3.drawio rename to docs/dashboards-reports/dev/resources/arch_3.drawio diff --git a/dashboards-reports/docs/dev/resources/dashboard_reports.drawio b/docs/dashboards-reports/dev/resources/dashboard_reports.drawio similarity index 100% rename from dashboards-reports/docs/dev/resources/dashboard_reports.drawio rename to docs/dashboards-reports/dev/resources/dashboard_reports.drawio diff --git a/dashboards-reports/docs/dev/resources/data_model.drawio b/docs/dashboards-reports/dev/resources/data_model.drawio similarity index 100% rename from dashboards-reports/docs/dev/resources/data_model.drawio rename to docs/dashboards-reports/dev/resources/data_model.drawio diff --git a/dashboards-reports/docs/dev/resources/delivery.drawio b/docs/dashboards-reports/dev/resources/delivery.drawio similarity index 100% rename from dashboards-reports/docs/dev/resources/delivery.drawio rename to docs/dashboards-reports/dev/resources/delivery.drawio diff --git a/dashboards-reports/docs/dev/resources/workflows.drawio b/docs/dashboards-reports/dev/resources/workflows.drawio similarity index 100% rename from dashboards-reports/docs/dev/resources/workflows.drawio rename to docs/dashboards-reports/dev/resources/workflows.drawio diff --git a/dashboards-reports/docs/ux/OpenSearch-Dashboards-Reporting-UX-documentation.md b/docs/dashboards-reports/ux/OpenSearch-Dashboards-Reporting-UX-documentation.md similarity index 100% rename from dashboards-reports/docs/ux/OpenSearch-Dashboards-Reporting-UX-documentation.md rename to docs/dashboards-reports/ux/OpenSearch-Dashboards-Reporting-UX-documentation.md diff --git a/dashboards-reports/docs/ux/img/flows/0.0.1_key-user-flows.png b/docs/dashboards-reports/ux/img/flows/0.0.1_key-user-flows.png similarity index 100% rename from dashboards-reports/docs/ux/img/flows/0.0.1_key-user-flows.png rename to docs/dashboards-reports/ux/img/flows/0.0.1_key-user-flows.png diff --git a/dashboards-reports/docs/ux/img/flows/0.0.1_key-user-flows@2x.png b/docs/dashboards-reports/ux/img/flows/0.0.1_key-user-flows@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/flows/0.0.1_key-user-flows@2x.png rename to docs/dashboards-reports/ux/img/flows/0.0.1_key-user-flows@2x.png diff --git a/dashboards-reports/docs/ux/img/flows/0.0.2_key-screens.png b/docs/dashboards-reports/ux/img/flows/0.0.2_key-screens.png similarity index 100% rename from dashboards-reports/docs/ux/img/flows/0.0.2_key-screens.png rename to docs/dashboards-reports/ux/img/flows/0.0.2_key-screens.png diff --git a/dashboards-reports/docs/ux/img/flows/0.0.2_key-screens@2x.png b/docs/dashboards-reports/ux/img/flows/0.0.2_key-screens@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/flows/0.0.2_key-screens@2x.png rename to docs/dashboards-reports/ux/img/flows/0.0.2_key-screens@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.1.01_dashboard-download.png b/docs/dashboards-reports/ux/img/screens/0.1.01_dashboard-download.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.1.01_dashboard-download.png rename to docs/dashboards-reports/ux/img/screens/0.1.01_dashboard-download.png diff --git a/dashboards-reports/docs/ux/img/screens/0.1.01_dashboard-download@2x.png b/docs/dashboards-reports/ux/img/screens/0.1.01_dashboard-download@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.1.01_dashboard-download@2x.png rename to docs/dashboards-reports/ux/img/screens/0.1.01_dashboard-download@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.1.02_dashboard-share.png b/docs/dashboards-reports/ux/img/screens/0.1.02_dashboard-share.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.1.02_dashboard-share.png rename to docs/dashboards-reports/ux/img/screens/0.1.02_dashboard-share.png diff --git a/dashboards-reports/docs/ux/img/screens/0.1.02_dashboard-share@2x.png b/docs/dashboards-reports/ux/img/screens/0.1.02_dashboard-share@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.1.02_dashboard-share@2x.png rename to docs/dashboards-reports/ux/img/screens/0.1.02_dashboard-share@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.1.03_dashboard-toasts.png b/docs/dashboards-reports/ux/img/screens/0.1.03_dashboard-toasts.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.1.03_dashboard-toasts.png rename to docs/dashboards-reports/ux/img/screens/0.1.03_dashboard-toasts.png diff --git a/dashboards-reports/docs/ux/img/screens/0.1.03_dashboard-toasts@2x.png b/docs/dashboards-reports/ux/img/screens/0.1.03_dashboard-toasts@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.1.03_dashboard-toasts@2x.png rename to docs/dashboards-reports/ux/img/screens/0.1.03_dashboard-toasts@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.1.0_dashboard.png b/docs/dashboards-reports/ux/img/screens/0.1.0_dashboard.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.1.0_dashboard.png rename to docs/dashboards-reports/ux/img/screens/0.1.0_dashboard.png diff --git a/dashboards-reports/docs/ux/img/screens/0.1.0_dashboard@2x.png b/docs/dashboards-reports/ux/img/screens/0.1.0_dashboard@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.1.0_dashboard@2x.png rename to docs/dashboards-reports/ux/img/screens/0.1.0_dashboard@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.2.0_reporting_empty-state.png b/docs/dashboards-reports/ux/img/screens/0.2.0_reporting_empty-state.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.2.0_reporting_empty-state.png rename to docs/dashboards-reports/ux/img/screens/0.2.0_reporting_empty-state.png diff --git a/dashboards-reports/docs/ux/img/screens/0.2.0_reporting_empty-state@2x.png b/docs/dashboards-reports/ux/img/screens/0.2.0_reporting_empty-state@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.2.0_reporting_empty-state@2x.png rename to docs/dashboards-reports/ux/img/screens/0.2.0_reporting_empty-state@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.2.1_reporting.png b/docs/dashboards-reports/ux/img/screens/0.2.1_reporting.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.2.1_reporting.png rename to docs/dashboards-reports/ux/img/screens/0.2.1_reporting.png diff --git a/dashboards-reports/docs/ux/img/screens/0.2.1_reporting@2x.png b/docs/dashboards-reports/ux/img/screens/0.2.1_reporting@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.2.1_reporting@2x.png rename to docs/dashboards-reports/ux/img/screens/0.2.1_reporting@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.3.0_report.png b/docs/dashboards-reports/ux/img/screens/0.3.0_report.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.3.0_report.png rename to docs/dashboards-reports/ux/img/screens/0.3.0_report.png diff --git a/dashboards-reports/docs/ux/img/screens/0.3.0_report@2x.png b/docs/dashboards-reports/ux/img/screens/0.3.0_report@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.3.0_report@2x.png rename to docs/dashboards-reports/ux/img/screens/0.3.0_report@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.3.1_report_share.png b/docs/dashboards-reports/ux/img/screens/0.3.1_report_share.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.3.1_report_share.png rename to docs/dashboards-reports/ux/img/screens/0.3.1_report_share.png diff --git a/dashboards-reports/docs/ux/img/screens/0.3.1_report_share@2x.png b/docs/dashboards-reports/ux/img/screens/0.3.1_report_share@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.3.1_report_share@2x.png rename to docs/dashboards-reports/ux/img/screens/0.3.1_report_share@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.4.0_report-definition.png b/docs/dashboards-reports/ux/img/screens/0.4.0_report-definition.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.4.0_report-definition.png rename to docs/dashboards-reports/ux/img/screens/0.4.0_report-definition.png diff --git a/dashboards-reports/docs/ux/img/screens/0.4.0_report-definition@2x.png b/docs/dashboards-reports/ux/img/screens/0.4.0_report-definition@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.4.0_report-definition@2x.png rename to docs/dashboards-reports/ux/img/screens/0.4.0_report-definition@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.5.0_create-report-definition.png b/docs/dashboards-reports/ux/img/screens/0.5.0_create-report-definition.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.5.0_create-report-definition.png rename to docs/dashboards-reports/ux/img/screens/0.5.0_create-report-definition.png diff --git a/dashboards-reports/docs/ux/img/screens/0.5.0_create-report-definition@2x.png b/docs/dashboards-reports/ux/img/screens/0.5.0_create-report-definition@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.5.0_create-report-definition@2x.png rename to docs/dashboards-reports/ux/img/screens/0.5.0_create-report-definition@2x.png diff --git a/dashboards-reports/docs/ux/img/screens/0.6.0_edit-report-definition.png b/docs/dashboards-reports/ux/img/screens/0.6.0_edit-report-definition.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.6.0_edit-report-definition.png rename to docs/dashboards-reports/ux/img/screens/0.6.0_edit-report-definition.png diff --git a/dashboards-reports/docs/ux/img/screens/0.6.0_edit-report-definition@2x.png b/docs/dashboards-reports/ux/img/screens/0.6.0_edit-report-definition@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/screens/0.6.0_edit-report-definition@2x.png rename to docs/dashboards-reports/ux/img/screens/0.6.0_edit-report-definition@2x.png diff --git a/dashboards-reports/docs/ux/img/supporting/0.1.04_modals_generating-downloading.png b/docs/dashboards-reports/ux/img/supporting/0.1.04_modals_generating-downloading.png similarity index 100% rename from dashboards-reports/docs/ux/img/supporting/0.1.04_modals_generating-downloading.png rename to docs/dashboards-reports/ux/img/supporting/0.1.04_modals_generating-downloading.png diff --git a/dashboards-reports/docs/ux/img/supporting/0.1.04_modals_generating-downloading@2x.png b/docs/dashboards-reports/ux/img/supporting/0.1.04_modals_generating-downloading@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/supporting/0.1.04_modals_generating-downloading@2x.png rename to docs/dashboards-reports/ux/img/supporting/0.1.04_modals_generating-downloading@2x.png diff --git a/dashboards-reports/docs/ux/img/supporting/0.5.1_report-settings.png b/docs/dashboards-reports/ux/img/supporting/0.5.1_report-settings.png similarity index 100% rename from dashboards-reports/docs/ux/img/supporting/0.5.1_report-settings.png rename to docs/dashboards-reports/ux/img/supporting/0.5.1_report-settings.png diff --git a/dashboards-reports/docs/ux/img/supporting/0.5.1_report-settings@2x.png b/docs/dashboards-reports/ux/img/supporting/0.5.1_report-settings@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/supporting/0.5.1_report-settings@2x.png rename to docs/dashboards-reports/ux/img/supporting/0.5.1_report-settings@2x.png diff --git a/dashboards-reports/docs/ux/img/supporting/0.5.2_report-trigger.png b/docs/dashboards-reports/ux/img/supporting/0.5.2_report-trigger.png similarity index 100% rename from dashboards-reports/docs/ux/img/supporting/0.5.2_report-trigger.png rename to docs/dashboards-reports/ux/img/supporting/0.5.2_report-trigger.png diff --git a/dashboards-reports/docs/ux/img/supporting/0.5.2_report-trigger@2x.png b/docs/dashboards-reports/ux/img/supporting/0.5.2_report-trigger@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/supporting/0.5.2_report-trigger@2x.png rename to docs/dashboards-reports/ux/img/supporting/0.5.2_report-trigger@2x.png diff --git a/dashboards-reports/docs/ux/img/supporting/0.5.3_delivery-settings.png b/docs/dashboards-reports/ux/img/supporting/0.5.3_delivery-settings.png similarity index 100% rename from dashboards-reports/docs/ux/img/supporting/0.5.3_delivery-settings.png rename to docs/dashboards-reports/ux/img/supporting/0.5.3_delivery-settings.png diff --git a/dashboards-reports/docs/ux/img/supporting/0.5.3_delivery-settings@2x.png b/docs/dashboards-reports/ux/img/supporting/0.5.3_delivery-settings@2x.png similarity index 100% rename from dashboards-reports/docs/ux/img/supporting/0.5.3_delivery-settings@2x.png rename to docs/dashboards-reports/ux/img/supporting/0.5.3_delivery-settings@2x.png diff --git a/docs/NotificationPluginIntegration.puml b/docs/notifications/NotificationPluginIntegration.puml similarity index 100% rename from docs/NotificationPluginIntegration.puml rename to docs/notifications/NotificationPluginIntegration.puml diff --git a/docs/NotificationPluginInteraction.puml b/docs/notifications/NotificationPluginInteraction.puml similarity index 100% rename from docs/NotificationPluginInteraction.puml rename to docs/notifications/NotificationPluginInteraction.puml