opensearch-project/dashboards-notebooks

Combine code snippets, live visualizations, and narrative text into rich reports in OpenSearch Dashboards

dashboards-notebooks's Issues

[BUG] Long passages of text trigger unusual error message

Describe the bug
Paragraph codeblocks fail with very long text entry (tired pasting in the entire text of Moby Dick, several Mbs) -> Error message "Error running paragraph, please make sure you have the correct permission."

Expected behavior
Either the error message would be more exact (it has nothing to do with permissions) or limit the number of character allowed in the text box

Plugins
All OpenSearch

Host/Environment (please complete the following information):

• OS: macOS
• Version: Chrome / Version 90.0.4430.212 (Official Build) (x86_64)
• OpenSearch 1.0 RC1

Add multi column layout to notebooks

Is your feature request related to a problem? Please describe.
Currently, there is no possibility to add multiple columns for paragraphs inside notebooks.
So you only have one row and you can append paragraphs only in one existing column (at the top or bottom).

Describe the solution you'd like
It would be great to have the possibility to have a multi column layout in notebooks.
Then you can place paragraphs next to each other.
The goal is to have a better formatted pdf report of notebooks. Visualizations next to eacht other for example.

Correct copyright notices to reflect Copyright OpenSearch Contributors

Coming from opensearch-project/.github#21.

The correct copyright for open-source projects in opensearch-project is "Copyright OpenSearch Contributors". Please correct any places that say otherwise, especially where it says copyright Amazon. Make sure NOTICE.txt and README match. See opensearch-project/.github#24 for an example.

[BUG] Select * Queries Hide Columns

Describe the bug
When running select * queries in code block paragraphs, sometimes the data grid hides all columns on running output.

To Reproduce
Steps to reproduce the behavior:

1. Enter a select * query in a Notebooks paragraph
2. Run the paragraph
3. Check if the data grid returns all columns hidden

Expected behavior
All columns in data grid should be displayed by default on every query run.

Plugins
Dashboards-notebooks

[BUG] report for notebook renders the security tenant pop-up

Describe the bug
This is what pdf/png report looks like, when security plugin is enabled. It shoudn't render the tenant selection box

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Plugins
Please list all plugins currently enabled.

Screenshots
If applicable, add screenshots to help explain your problem.

Host/Environment (please complete the following information):

• OS: [e.g. iOS]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Ensure DCO Workflow Check

Coming from opensearch-project/project-meta#17

A Developer Certificate of Origin is required on commits in the OpenSearch-Project.

See doc.yml for an example workflow. Ensure CONTRIBUTING.md to has a section on the DCO per the project template.

• DCO Check Workflow
• CONTRIBUTING.md DCO Section

Standardize branching to match OpenSearch

Coming from .github#13, standardize release branching to match what OpenSearch is doing.

1. Create a 1.0 branch for the OpenSearch 1.0 release, 1.x branch for next 1.1 release, and use main for 2.0 development. Make sure CI is enabled on those.
2. Update your release/branching documentation. If you don't have one, add a RELEASING.md that links to, or has content from .github/RELEASING.md.
3. If you are using a develop branch, stop. You should be using the default main brach for furthermost, future development.
4. Delete any merged/stale/develop/feature branches that are no longer in use.
5. Communicate any changes in process to your team.

Refer to release branching for more information.

Fit and Finish Changes to Notebooks UX

Is your feature request related to a problem? Please describe.
Make improvements to Notebooks UI based on UX comments including:

• Consistency in button naming scheme (e.g Notebook actions and Paragraph actions)
• Add external documentation links for SQL/PPL
• Reduce info text length on Notebooks landing page
• Fix "Last run" statement
• Update cypress tests to reflect changes

Add Windows Support

Coming from opensearch-project/opensearch-plugins#95, add Windows support.

• Passing CI on Windows
• Documentation

Changing the name of osd plugin-helpers file naming to match the config

Is your feature request related to a problem? Please describe.
The opensearch-dashboards-plugin-helpers.dev.json file in dashboards-notebooks should be named .opensearch_dashboards-plugin-helpers.json according to https://github.com/opensearch-project/OpenSearch-Dashboards/tree/9a2d3e6918760c4bba8b44b9e8dfcd14e459a916/packages/osd-plugin-helpers#configuration

Describe the solution you'd like
Changing the name of plugin-helpers file naming to match the config as mentioned here. The previous file name is "opensearch-dashboards-plugin-helpers.dev.json", shoudl change to".opensearch_dashboards-plugin-helpers.json"

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Ensure opensearch-notebooks backwards compatibility with ODFE

Coming from opensearch-plugins#12, enable upgrade to OpenSearch, while supporting backward compatibility in opensearch-notebooks.

• Rename Namespaces (e.g. com.amazon.opendistroforelasticsearch to org.opensearch)
• Rename Classes, Methods, Variables
• Rename Remaining Identifiers (e.g. Opendistro to OpenSearch).
• Rename, and Backwards Compatibility for Rest APIs
• Rename, and Backwards Compatibility for Settings
• Rename, and Backwards Compatibility for Indices
• Run in a backwards compatible way on top of OpenSearch 1.0 that has joined an ES 7.10.x cluster
• Run in a backwards compatible way on top of OpenSearch 1.0 that has joined an ODFE 1.13.x cluster
• Drop in replacement for the Opendistro version 1.13 of the plugin

[BUG] "Search notebooks" only searches the *names* of notebooks.

Describe the bug
On the notebooks dashboard (/app/notebooks-dashboards) the search bar only searches the names the notebooks, not any contents. This is confusing.

Expected behavior
If you have the word "peanut" on one of your reports, querying the bar on /app/notebooks-dashboards for "peanut" would filter the list to only reports that contain "peanut"

Plugins
All OpenSearch

Host/Environment (please complete the following information):

• OS: MacOS Chrome
• Version Version 90.0.4430.212 (Official Build) (x86_64)
• OpenSearch 1.0 RC1

Add MacOS Support

Coming from opensearch-project/opensearch-plugins#96, add MacOS (Darwin) support.

• Passing CI on MacOS
• Documentation

Level up README and related markdown content

Level up and cleanup markdown content.

See .github#8 for details and recommendations, and common-utils for an example.

• README.md
• CONTRIBUTING.md
• DEVELOPER_GUIDE.md
• MAINTAINERS.md
• ADMINS.md
• SECURITY.md
• RELEASING.md
• TESTING.md
• other .md files

[BUG] Snapshot build doesn't produce -SNAPSHOT artifact

Describe the bug

Coming from opensearch-project/opensearch-build#179, the build with -Dbuild.snapshot=true doesn't produce snapshot outputs. When fixing this, update to use OpenSearch 1.1 from 1.x branch.

To Reproduce

cd opensearch-notebooks
./gradlew assemble --no-daemon --refresh-dependencies -DskipTests=true -Dopensearch.version=1.1.0-SNAPSHOT -Dbuild.snapshot=true

Creates opensearch-notebooks-1.1.0.0.zip.

Expected behavior

Expected opensearch-notebooks-1.1.0.0-SNAPSHOT.zip.

Check other artifacts (maven?) if any.

Update plugin description

Coming from opensearch-project/opensearch-plugins#92.

Each plugin has a short descriptive text blurb that says what it does: this appears in plugin-descriptor.properties (OpenSearch plugins) or package.json (OpenSearch Dashboards plugins), as well as on the project website's "source" page and in the "About" section of every repo. These were created one-by-one over the years as plugins were created, so looking at them all together now it would be hard for somebody new to the project to use these to understand what the plugins do.

[BUG] "Learn more" Documentation Link Incorrect

Describe the bug
"Learn more" within Notebooks links to https://opendistro.github.io/for-elasticsearch-docs/docs/kibana/notebooks/ rather than https://docs-beta.opensearch.org/docs/opensearch-dashboards/notebooks/.

To Reproduce
Steps to reproduce the behavior:

1. Go to 'Notebooks'
2. Click on 'Learn more'
3. See error

Expected behavior
Link should pass to https://docs-beta.opensearch.org/docs/opensearch-dashboards/notebooks/

Plugins
N/A

Screenshots

Host/Environment (please complete the following information):
N/A

Additional context
None

Add auto backport functionality to backport PRs for releases

Coming from meta issue opensearch-project/opensearch-plugins#108:

• Add auto-backport PR creation Github action to make sure all the PRs are backported for a particular release. Related documentation: https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md.
• Add documentation for the same.

Use SNAPSHOT artifacts from maven for dependencies

Coming from opensearch-project/opensearch-plugins#45, use SNAPSHOT Maven dependencies from aws.oss.sonatype.org. See https://github.com/opensearch-project/opensearch-plugins/blob/main/BUILDING.md#building-within-the-opensearch-build-system for details.

Onboard to OpenSearch Dashboards distribution build automation.

Coming from opensearch-build#652, onboard this plugin to the OpenSearch Dashboards 1.1.0 manifest. See opensearch-build#652 and onboarding for more details.

Use SNAPSHOT artifacts from maven for dependencies

Coming from opensearch-project/opensearch-plugins#45, use SNAPSHOT Maven dependencies from aws.oss.sonatype.org. See https://github.com/opensearch-project/opensearch-plugins/blob/main/BUILDING.md#building-within-the-opensearch-build-system for details.

https://github.com/opensearch-project/dashboards-notebooks/blob/main/.github/workflows/opensearch-notebooks-test-and-build-workflow.yml#L23

Change background color of notebooks

Is your feature request related to a problem? Please describe.
Currently, it is not possible to change the background color in notebooks. It always uses the background color and design from the selected theme mode (dark mode or white).

Describe the solution you'd like
It would be very nice to have a button to change the background color of the notebook, maybe with custom color codes.

Change background color of notebooks

Is your feature request related to a problem? Please describe.
Currently, it is not possible to change the background color in notebooks. It always uses the background color and design from the selected theme mode (dark mode or white).

Describe the solution you'd like
It would be very nice to have a button to change the background color of the notebook.

[BUG] The repo is undescribed

Describe the bug
This repo lacks a description

Other plugins installed
N/a

To Reproduce
Steps to reproduce the behavior:

1. Go to https://github.com/opensearch-project/dashboards-notebooks/ in any browser
2. Look to the right, a little down from the top of the page
3. Instead of a user friendly description, you'll see something like this:

Expected behavior
To see a one-line description of what this repo does.

Screenshots
See above

Optimize Notebooks Performance

Is your feature request related to a problem? Please describe.
Paragraphs re-render on every edit currently. When there start to be a larger number of paragraph (e.g 8-10), the plugin starts to noticeably lag.

Describe the solution you'd like
Optimize performance to prevent re-render on edit.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Update to Gradle 7

Is your feature request related to a problem? Please describe.
The OpenSearch Plugins are still built using Gradle 6.6.x whereas the Gradle release train has moved to 7.x already. The OpenSearch core is about to be switched to Gradle 7.3 (see please opensearch-project/OpenSearch#1609), it would make sense to switch all plugins to Gradle 7.3 as well.

Describe the solution you'd like
Update Gradle to 7.3

Describe alternatives you've considered (Optional)
N/A

Additional context
See please opensearch-project/OpenSearch#1246 and opensearch-project/opensearch-plugins#107

[BUG] Need to update the opensearch-plugins repo by removing your plugin if deprecated.

Describe the bug
https://github.com/opensearch-project/opensearch-plugins/blob/main/.meta
https://github.com/opensearch-project/opensearch-plugins/blob/main/dashboards-plugins/.meta

I talked to @joshuali925 @davidcui1225 that notebooks is deprecated for now.
Therefore, it needs to be removed from opensearch-plugins repo meta files.

Please proceed and send PRs there.

Thanks.

To Reproduce
See above.

Expected behavior
A clear and concise description of what you expected to happen.

Plugins
Please list all plugins currently enabled.

Screenshots
If applicable, add screenshots to help explain your problem.

Host/Environment (please complete the following information):

• OS: [e.g. iOS]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Remove jcenter repository

Description

JCenter has been turned off and should be removed as a referenced repository.

Please Remove any direct dependency on jcenter() within a repositories block in gradle files.

Related: opensearch-project/opensearch-build#1456

Release version 1.2

Coming from opensearch-build#567, release version 1.2. Please follow the following checklist.

Preparation

• Assign this issue to a release owner.
• Finalize scope and feature set and update the Public Roadmap.
• Create, update, triage and label all features and issues targeted for this release with v1.2.0.

CI/CD

• Increment version on main to 1.2.0.0.
• Ensure working and passing CI.
• Re(add) this repo to the manifest.

Pre-Release

• Branch and build from a 1.2 branch.
• Update your branch in the manifest.
• Feature complete, pencils down.
• Fix bugs that target this release.

Release

• Complete documentation.
• Gather, review and publish release notes.
• Verify all issued labeled for this release are closed or labelled for the next release.

Post Release

• Create a release tag.
• Suggest improvements to this template.
• Conduct a postmortem, and publish its results.

Release version 1.1.1

This is a component issue for release 1.1.1.
Coming from release issue 1.1.1, release version 1.1.1. Please follow the following checklist.

How to use this component issue

This Component Issue

This component issue captures the state of the OpenSearch release, on component/plugin level, its assignee is responsible for driving the release of the component. Please contact them or @mention them on this issue for help.

Release Steps

There are several steps to the release process, components that are behind present risk to the release. Component owners resolve tasks on this ticket to communicate with the overall release owner.

Steps have completion dates for coordinating efforts between the components of a release; components can start as soon as they are ready far in advance of a future release.

You can find all the corresponding dates of each step in the release issue above.

What should I do if my plugin isn't making any changes?

If including changes in this release, increment the version on 1.1 branch to 1.1.1 for Min/Core, and 1.1.1.0 for components. Otherwise, keep the version number unchanged for both.

You can find all the date in above issue

Preparation

• Assign this issue to a release owner.
• All the tasks in this issue have been reviewed by the release owner.
• Create, update, triage and label all features and issues targeted for this release with v1.1.1.

CI/CD

• All code changes for 1.1.1 are complete.
• Ensure working and passing CI.

Pre-Release

• Confirm that all changes for 1.1.1 have been merged.
• Complete integration and sanity tests, and update results in the comment, example.
• Find/fix bugs using latest tarball and docker image provided in meta issue.
• Completed release candidate testing build #TBD.
• All intermittent test failures have issues filed.

Release

• Complete documentation.
• Gather, review and publish release notes.
• Verify all issued labeled for this release are closed or labelled for the next release.

Post Release

• Create a release tag.
• Suggest improvements to this template.
• Conduct a retrospect, and publish its results.