added code summary table #243
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,8 @@ | ||
| <img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px"> | ||
|
|
||
| - [OpenSearch Dashboards Reports](#opensearch-dashboards-reports) | ||
| - [Code Summary](#code-summary) | ||
| - [Documentation](#documentation) | ||
| - [Contributing](#contributing) | ||
| - [Setup](#setup-&-build) | ||
| - [Notifications Integration](#notifications-integration) | ||
|
|
@@ -20,6 +16,75 @@ | |
|
|
||
| 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. | ||
|
|
||
| ## Code Summary | ||
|
|
||
| ### OpenSearch-Plugin | ||
|
|
||
| | | | | ||
| | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Test and build | [![Observability OpenSearch Build CI][opensearch-build-badge]][opensearch-build-link] | | ||
| | Code coverage | [![codecov][opensearch-codecov-badge]][codecov-link] | | ||
| | Distribution build tests | [![OpenSearch IT tests][opensearch-it-badge]][opensearch-it-link] [![OpenSearch IT code][opensearch-it-code-badge]][opensearch-it-code-link] | | ||
| | Backward compatibility tests | [![BWC tests][bwc-tests-badge]][bwc-tests-link] | | ||
|
|
||
| ### OpenSearch Dashboards-Plugin | ||
|
|
||
| | | | | ||
| | ------------------------ | ------------------------------------------------------------------------------------------------------------------ | | ||
| | Test and build | [![Observability Dashboards CI][dashboard-build-badge]][dashboard-build-link] | | ||
| | Code coverage | [![codecov][dashboard-codecov-badge]][codecov-link] | | ||
| | Distribution build tests | [![cypress tests][cypress-test-badge]][cypress-test-link] [![cypress code][cypress-code-badge]][cypress-code-link] | | ||
|
|
||
| ### Repository Checks | ||
|
|
||
| | | | | ||
| | ------------ | --------------------------------------------------------------- | | ||
| | DCO Checker | [![Developer certificate of origin][dco-badge]][dco-badge-link] | | ||
| | Link Checker | [![Link Checker][link-check-badge]][link-check-link] | | ||
|
|
||
| ### Issues | ||
|
|
||
| | | | ||
| | -------------------------------------------------------------- | | ||
| | [![good first issues open][good-first-badge]][good-first-link] | | ||
| | [![features open][feature-badge]][feature-link] | | ||
| | [![enhancements open][enhancement-badge]][enhancement-link] | | ||
| | [![bugs open][bug-badge]][bug-link] | | ||
|
|
||
| [dco-badge]: https://github.com/opensearch-project/dashboards-reports/actions/workflows/dco.yml/badge.svg | ||
| [dco-badge-link]: https://github.com/opensearch-project/dashboards-reports/actions/workflows/dco.yml | ||
| [link-check-badge]: https://github.com/opensearch-project/dashboards-reports/actions/workflows/link-checker.yml/badge.svg | ||
| [link-check-link]: https://github.com/opensearch-project/dashboards-reports/actions/workflows/link-checker.yml | ||
| [dashboard-build-badge]: https://github.com/opensearch-project/dashboards-reports/actions/workflows/dashboards-reports-test-and-build-workflow.yml/badge.svg | ||
| [dashboard-build-link]: https://github.com/opensearch-project/dashboards-reports/actions/workflows/dashboards-reports-test-and-build-workflow.yml | ||
| [opensearch-build-badge]: https://github.com/opensearch-project/dashboards-reports/actions/workflows/reports-scheduler-test-and-build-workflow.yml/badge.svg | ||
| [opensearch-build-link]: https://github.com/opensearch-project/dashboards-reports/actions/workflows/reports-scheduler-test-and-build-workflow.yml | ||
| [dashboard-codecov-badge]: https://codecov.io/gh/opensearch-project/dashboards-reports/branch/main/graphs/badge.svg?flag=dashboards-reports | ||
| [opensearch-codecov-badge]: https://codecov.io/gh/opensearch-project/dashboards-reports/branch/main/graphs/badge.svg?flag=reports-scheduler | ||
| [codecov-link]: https://codecov.io/gh/opensearch-project/dashboards-reports | ||
| [cypress-test-badge]: https://img.shields.io/badge/Cypress%20tests-in%20progress-yellow | ||
| [cypress-test-link]: https://github.com/opensearch-project/opensearch-build/issues/1124 | ||
| [cypress-code-badge]: https://img.shields.io/badge/Cypress%20code-blue | ||
| [cypress-code-link]: https://github.com/opensearch-project/dashboards-reports/tree/main/dashboards-reports/.cypress/integration | ||
| [opensearch-it-badge]: https://img.shields.io/badge/OpenSearch%20Plugin%20IT%20tests-in%20progress-yellow | ||
| [opensearch-it-link]: https://github.com/opensearch-project/opensearch-build/issues/1124 | ||
| [opensearch-it-code-badge]: https://img.shields.io/badge/OpenSearch%20IT%20code-blue | ||
| [opensearch-it-code-link]: https://github.com/opensearch-project/dashboards-reports/blob/main/reports-scheduler/src/test/kotlin/org/opensearch/observability/ObservabilityPluginIT.kt | ||
|
|
||
| [bwc-tests-badge]: https://img.shields.io/badge/BWC%20tests-in%20progress-yellow | ||
| [bwc-tests-link]: https://github.com/opensearch-project/dashboards-reports/issues/240 | ||
|
There was a problem hiding this comment. you may change this, since the PR has just been merged in There was a problem hiding this comment. Should I link this to the #244 files for now? Once, the bwc tests start running on Jenkins' distribution builds we can link to it. There was a problem hiding this comment. yeah linking to the files for now makes sense to me. |
||
| [good-first-badge]: https://img.shields.io/github/issues/opensearch-project/dashboards-reports/good%20first%20issue.svg | ||
| [good-first-link]: https://github.com/opensearch-project/dashboards-reports/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+ | ||
| [feature-badge]: https://img.shields.io/github/issues/opensearch-project/dashboards-reports/feature%20request.svg | ||
| [feature-link]: https://github.com/opensearch-project/dashboards-reports/issues?q=is%3Aopen+is%3Aissue+label%3A%22feature+request%22+ | ||
| [bug-badge]: https://img.shields.io/github/issues/opensearch-project/dashboards-reports/bug.svg | ||
| [bug-link]: https://github.com/opensearch-project/dashboards-reports/issues?q=is%3Aopen+is%3Aissue+label%3Abug+ | ||
| [enhancement-badge]: https://img.shields.io/github/issues/opensearch-project/dashboards-reports/enhancement.svg | ||
| [enhancement-link]: https://github.com/opensearch-project/dashboards-reports/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement+ | ||
|
|
||
| ## Documentation | ||
|
|
||
| Please see our technical [documentation](https://opensearch.org/docs/dashboards/reporting/) to learn more about its features. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome you to get involved in development, documentation, testing the OpenSearch Dashboards reports plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in. | ||
|
|
@@ -46,23 +111,25 @@ There could be two reasons for this problem | |
| 2. Missing additional dependencies. Please refer to [additional dependencies section](./dashboards-reports/rendering-engine/headless-chrome/README.md#additional-libaries) to install required dependencies according to your operating system. | ||
|
|
||
| ### Missing Font Dependencies | ||
|
|
||
| Chromium may not have all of the dependencies you may require to be able to view all of the content of your reports. | ||
|
|
||
| If you are using a CentOS/RHEL system, install the following packages: | ||
|
|
||
| - [`ipa-gothic-fonts`](https://centos.pkgs.org/7/centos-x86_64/ipa-gothic-fonts-003.03-5.el7.noarch.rpm.html) | ||
| - [`xorg-x11-fonts-100dpi`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-100dpi-7.5-9.el7.noarch.rpm.html) | ||
| - [`xorg-x11-fonts-75dpi`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-75dpi-7.5-9.el7.noarch.rpm.html) | ||
| - [`xorg-x11-utils`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-utils-7.5-23.el7.x86_64.rpm.html) | ||
| - [`xorg-x11-fonts-cyrillic`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-cyrillic-7.5-9.el7.noarch.rpm.html) | ||
| - [`xorg-x11-fonts-Type1`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-Type1-7.5-9.el7.noarch.rpm.html) | ||
| - [`xorg-x11-fonts-misc`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-misc-7.5-9.el7.noarch.rpm.html) | ||
| - [`fontconfig`](https://www.freedesktop.org/wiki/Software/fontconfig/) | ||
| - [`freetype`](https://freetype.org/) | ||
|
|
||
| If you are using a Ubuntu/Debian system, install the following packages: | ||
|
|
||
| - [`fonts-liberation`](https://packages.debian.org/search?keywords=fonts-liberation) | ||
| - [`libfontconfig1`](https://packages.debian.org/sid/libfontconfig1) | ||
|
|
||
| The installation command for both systems can be found [here](./dashboards-reports/rendering-engine/headless-chrome/README.md). | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please change the naming to dashboars-reports or reports-scheduler