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

[Worksapce][Feature] Update application category and retire dashboard management section #5281

Closed
wants to merge 6 commits into from

Conversation

raintygao
Copy link
Contributor

@raintygao raintygao commented Oct 12, 2023

Description

The main change of this PR are:

  • Rename Opensearch Dashboards category to Library.
  • Register Advance Settings as standalone application.
  • Register Data Source management as standalone application.
  • Register Index Pattern management as standalone application.
  • Rename SavedObject managementto Manage library as standalone application.
  • Retire dashboard management section.

Issues Resolved

#5280

Screenshot

image
Before change

image
After change

Testing the changes

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

raintygao and others added 2 commits October 12, 2023 11:36
…ement and SavedObject management as standalone app, retire dashboard management (opensearch-project#208)

* feat: init retire dashboard management

Signed-off-by: tygao <tygao@amazon.com>

* move index pattern to Library (opensearch-project#91)

* move index pattern to libaray

Signed-off-by: Hailong Cui <ihailong@amazon.com>

* Remove it from Dashboards management when workspace is on

Signed-off-by: Hailong Cui <ihailong@amazon.com>

---------

Signed-off-by: Hailong Cui <ihailong@amazon.com>

index pattern always show under library

Signed-off-by: Hailong Cui <ihailong@amazon.com>

* functional test

Signed-off-by: Hailong Cui <ihailong@amazon.com>

* feat: move data source / advanced settings / saved objects management out of Dashboard management

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: update test

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: update snapshot

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: update snapshot

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* fix: fix failed overview header ut

Signed-off-by: tygao <tygao@amazon.com>

* fix: deeplink inside saved objects management page

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* fix: unit test fail

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: add unit test for each page wrapper

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* feat: some optimization

Signed-off-by: SuZhou-Joe <suzhou@amazon.com>

* remove management dependency

Signed-off-by: Hailong Cui <ihailong@amazon.com>

* test: update cypress config to use workspace branch

Signed-off-by: tygao <tygao@amazon.com>

* Replace ManagementAppMountParams with AppMountParameters

Signed-off-by: Hailong Cui <ihailong@amazon.com>

---------

Signed-off-by: tygao <tygao@amazon.com>
Signed-off-by: Hailong Cui <ihailong@amazon.com>
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
Co-authored-by: Hailong Cui <ihailong@amazon.com>
Co-authored-by: SuZhou-Joe <suzhou@amazon.com>
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
@raintygao raintygao changed the title [Worksapce][Feature] Feat category pr [Worksapce][Feature] Update application category and retire dashboard management section Oct 12, 2023
@codecov
Copy link

codecov bot commented Oct 12, 2023

Codecov Report

Merging #5281 (5a5dacc) into main (b3104ce) will increase coverage by 0.01%.
Report is 3 commits behind head on main.
The diff coverage is 67.74%.

@@            Coverage Diff             @@
##             main    #5281      +/-   ##
==========================================
+ Coverage   66.74%   66.75%   +0.01%     
==========================================
  Files        3284     3288       +4     
  Lines       63095    63107      +12     
  Branches    10049    10048       -1     
==========================================
+ Hits        42110    42128      +18     
- Misses      18488    18582      +94     
+ Partials     2497     2397     -100     
Flag Coverage Δ
Linux_1 35.26% <26.31%> (+<0.01%) ⬆️
Linux_3 43.85% <44.44%> (+<0.01%) ⬆️
Linux_4 35.39% <62.96%> (+0.03%) ⬆️
Windows_1 35.28% <26.31%> (+<0.01%) ⬆️
Windows_2 55.20% <0.00%> (ø)
Windows_3 43.85% <44.44%> (+<0.01%) ⬆️
Windows_4 35.39% <62.96%> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/core/public/core_app/errors/url_overflow.tsx 88.23% <ø> (ø)
...rc/core/public/core_app/errors/url_overflow_ui.tsx 66.66% <ø> (ø)
...re/server/ui_settings/saved_objects/ui_settings.ts 33.33% <ø> (ø)
src/core/utils/default_app_categories.ts 100.00% <ø> (ø)
...ement_app/components/page_wrapper/page_wrapper.tsx 100.00% <100.00%> (ø)
...nt/public/components/page_wrapper/page_wrapper.tsx 100.00% <100.00%> (ø)
src/plugins/data_source_management/public/types.ts 100.00% <ø> (ø)
...plication/components/top_nav/open_search_panel.tsx 40.00% <ø> (ø)
.../public/application/components/new_theme_modal.tsx 33.33% <ø> (ø)
...lic/components/getting_started/getting_started.tsx 85.71% <ø> (ø)
... and 14 more

... and 22 files with indirect coverage changes

Signed-off-by: tygao <tygao@amazon.com>
Signed-off-by: tygao <tygao@amazon.com>
@Hailong-am
Copy link
Collaborator

@kavilla could you help to run cypress manually with branch workspace of opensearch-dashboards-functional-test repo, PR number is 5281

@kavilla
Copy link
Member

kavilla commented Oct 12, 2023

I think @opensearch-project/opensearch-ux mind commenting on this?

2.10 including nesting these settings deeper into management and then if this has a targetted release in minor branch we will be moving this again? I'd imagine as a user it would be frustrating within a couple minor bumps the navigation changed twice.

Could UX expand on this: #4287 (comment) and how come this is no longer relevant?

@github-actions
Copy link
Contributor

[MANUAL CYPRESS TEST RUN RESULTS]

❌ Cypress test run failed!

Inputs:

Source repo: ''
Source branch: ''
Test repo: 'opensearch-project/opensearch-dashboards-functional-test'
Test branch: 'workspace'

Test spec:
'cypress/integration/common/*.js,cypress/integration/core-opensearch-dashboards/opensearch-dashboards/**/*.js,'

Link to results:

https://github.com/opensearch-project/OpenSearch-Dashboards/actions/runs/6501446059

@xluo-aws
Copy link
Member

I think @opensearch-project/opensearch-ux mind commenting on this?

2.10 including nesting these settings deeper into management and then if this has a targetted release in minor branch we will be moving this again? I'd imagine as a user it would be frustrating within a couple minor bumps the navigation changed twice.

Could UX expand on this: #4287 (comment) and how come this is no longer relevant?

Hi, Rocky, the change in 4287 is relevant, we move functions that's considered as management related to management section/category. In workspace, this section and the applications under it (ISM, snapshot, security, etc) will only be available in management workspace. @kgcreative

SuZhou-Joe and others added 2 commits October 13, 2023 11:51
Signed-off-by: SuZhou-Joe <suzhou@amazon.com>
Signed-off-by: Hailong Cui <ihailong@amazon.com>
@kgcreative
Copy link
Member

I think these changes reflect the evolving thoughts as we get ready to launch workspaces. To be more specific, the Admin changes allows us to better organize those items. As we build workspaces, however, we realized that data sources, index patterns and saved objects are actually tenant objects (not dashboards-wide) objects, so those should be moved out of dashboards management and either into the library for each workspace, or to the workspace settings page. We need to think a bit more about some of these things, but our users should expect a bit of shuffling around as our thinking evolves and we align behind mental models. This will have a bit of churn, but we're trying to minimize how much whiplash our users get from this.

@kavilla
Copy link
Member

kavilla commented Oct 13, 2023

We need to think a bit more about some of these things, but our users should expect a bit of shuffling around as our thinking evolves and we align behind mental models. This will have a bit of churn, but we're trying to minimize how much whiplash our users get from this.

Do we have a mechanism that can help feed into making data back decisions? I know we don't have telemetry enabled but it might be useful to get to see the usage of users and maybe dog food into why we made menu changes.

@kavilla
Copy link
Member

kavilla commented Oct 13, 2023

As we build workspaces, however, we realized that data sources, index patterns and saved objects are actually tenant objects (not dashboards-wide) objects, so those should be moved out of dashboards management and either into the library for each workspace, or to the workspace settings page.

This makes a lot of sense. As I've seen huge features implement without realizing the the power of OpenSearch Dashboards core. Saved objects and index patterns being the backbone of OpenSearch Dashboards and it would be better for a cohesive experience if OSD Core and other plugins unified the way it queried data. This makes integrations eligible to rapid development. For example if all plugins onboarded to the data plugin and query service, then we can add the support for different query languages in the service itself and plugins do not have to do anything to get that support.

IMO, Dashboards Management was little bit confusing since there is a concept of Dashboards outside the core OSD node server.

@raintygao
Copy link
Contributor Author

raintygao commented Oct 17, 2023

IMO, Dashboards Management was little bit confusing since there is a concept of Dashboards outside the core OSD node server.

image

Before this PR, Dashboards Management was a section containing Index patterns, Data Sources, Saved Objects management and Advanced settings.

In this PR, items in this section are all moved out, and this section no longer exists.

@kavilla
Copy link
Member

kavilla commented Nov 1, 2023

Is this PR still valid based on: #5280 (comment)?

If not then we close or place into draft?

@raintygao
Copy link
Contributor Author

Is this PR still valid based on: #5280 (comment)?

If not then we close or place into draft?

Thanks for the reminder, I'll close it first.

@raintygao raintygao closed this Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Workspace][Feature] Update application category and retire dashboard management section
6 participants