chore: Sunset Omnibar Documentation and Snippets by hetunandu · Pull Request #24787 · appsmithorg/appsmith

hetunandu · 2023-06-23T09:56:53Z

Description

We are removing the documentation and snippets that used to be shown in the omnibar. These features are not being maintained and usage is pretty low.

PR fixes following issue(s)

Fixes #24278
Fixes #24279
Fixes #24280

Type of change

Breaking change (fix or feature that would cause existing functionality to not work as expected)

Testing

How Has This Been Tested?

Manual
Cypress

Test Plan

#24787 (comment)

Issues raised during DP testing

#24787 (comment)

Checklist:

Dev activity

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
PR is being merged under a feature flag

QA activity:

Speedbreak features have been covered
Test plan covers all impacted features and areas of interest
Test plan has been peer reviewed by project stakeholders and other QA members
Manually tested functionality on DP
We had an implementation alignment call with stakeholders post QA Round 2
Cypress test cases have been added and approved by SDET/manual QA
Added Test Plan Approved label after Cypress tests were reviewed
Added Test Plan Approved label after JUnit tests were reviewed

# Conflicts: # app/client/src/components/editorComponents/WidgetQueryGeneratorForm/CommonControls/DatasourceDropdown/useDatasource.tsx

hetunandu · 2023-06-23T10:33:48Z

/ok-to-test

github-actions · 2023-06-23T10:34:12Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/5355449388.
Workflow: Appsmith External Integration Test Workflow.
Commit: ``.
PR: 24787.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=24787&runId=5355449388_1

github-actions · 2023-06-23T11:28:52Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/5355449388.
Commit: ``.
The following are new failures, please fix them before merging the PR:

cypress/e2e/Regression/ClientSide/OtherUIFeatures/GlobalSearch_spec.js
cypress/e2e/Regression/ClientSide/OtherUIFeatures/Omnibar_spec.js
cypress/e2e/Regression/ClientSide/Widgets/Others/Autocomplete_spec.js

To know the list of identified flaky tests - Refer here

hetunandu · 2023-06-23T12:46:57Z

/ok-to-test

github-actions · 2023-06-23T12:47:22Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/5356515009.
Workflow: Appsmith External Integration Test Workflow.
Commit: ``.
PR: 24787.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=24787&runId=5356515009_1

akash-codemonk · 2023-06-23T13:30:29Z

We can also delete the file updating the algolia index in the docs repo https://github.com/appsmithorg/appsmith-docs/blob/main/website/omnibar-algolia-index.js and the workflow https://github.com/appsmithorg/appsmith-docs/blob/main/.github/workflows/deploy.yml#L43

akash-codemonk · 2023-06-23T13:32:36Z

/build-deploy-preview skip-tests=true

github-actions · 2023-06-23T13:33:00Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/5356938492.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 24787.
recreate: .

github-actions · 2023-06-23T13:43:23Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/5356515009.
Commit: ``.
The following are new failures, please fix them before merging the PR:

cypress/e2e/Regression/ClientSide/OtherUIFeatures/Omnibar_spec.js
cypress/e2e/Regression/ClientSide/Widgets/Others/Autocomplete_spec.js
cypress/e2e/Regression/ClientSide/Widgets/TableV2/TableV2_PropertyPane_1_spec.js

To know the list of identified flaky tests - Refer here

github-actions · 2023-06-23T13:49:01Z

Deploy-Preview-URL: https://ce-24787.dp.appsmith.com

ghost · 2023-06-28T14:03:23Z

@hetunandu Please have a look into below issues

Tooltip "Open doc in omnibar" displays even though we have removed documentation from omnibar.
"Get Appsmith Support" link does not display in error tab on DP and Release both but it displays on prod.

# Conflicts: # app/client/cypress/e2e/Regression/ClientSide/OtherUIFeatures/Omnibar_spec.js # app/client/src/components/editorComponents/CodeEditor/generateQuickCommands.tsx

hetunandu · 2023-06-29T07:37:04Z

/ok-to-test

github-actions · 2023-06-29T07:37:31Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/5409674449.
Workflow: Appsmith External Integration Test Workflow.
Commit: ``.
PR: 24787.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=24787&runId=5409674449_1

hetunandu · 2023-06-29T07:38:12Z

/build-deploy-preview env=release

github-actions · 2023-06-29T07:38:37Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/5409682895.
Workflow: On demand build Docker image and deploy preview.
skip-tests: ``.
env: release.
PR: 24787.
recreate: .

github-actions · 2023-06-29T08:03:58Z

Deploy-Preview-URL: https://appsmith-d80mzzj0c-get-appsmith.vercel.app

github-actions · 2023-06-29T08:39:42Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/5409674449.
Commit: ``.
Cypress dashboard url: Click here!
All cypress tests have passed 🎉🎉🎉

hetunandu · 2023-06-30T04:47:09Z

/ok-to-test

github-actions · 2023-06-30T04:47:33Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/5419389218.
Workflow: Appsmith External Integration Test Workflow.
Commit: ``.
PR: 24787.
Perf tests will be available at https://app.appsmith.com/app/performance-infra-dashboard/pr-details-638dd7cd2913ba43778b915e?pr=24787&runId=5419389218_1

github-actions · 2023-06-30T05:45:53Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/5419389218.
Commit: ``.
Cypress dashboard: Click here!
The following are new failures, please fix them before merging the PR:

cypress/e2e/Regression/ClientSide/Templates/Fork_Template_To_App_spec.js

To know the list of identified flaky tests - Refer here

github-actions · 2023-06-30T08:54:02Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/5419389218.
Commit: ``.
Cypress dashboard: Click here!
The following are new failures, please fix them before merging the PR:

cypress/e2e/Fork_Template_To_App_spec.js

To know the list of identified flaky tests - Refer here

ghost · 2023-06-30T10:00:33Z

@hetunandu Please have a look into below issues

Tooltip "Open doc in omnibar" displays even though we have removed documentation from omnibar.

Fixed and working fine. Now tool tip says "Open docs in tab" : https://appsmith-d80mzzj0c-get-appsmith.vercel.app/

"Get Appsmith Support" link does not display in error tab on DP and Release both but it displays on prod.

Removes algolia indexing work as we will not be using this in our app anymore. [Reference](appsmithorg/appsmith#24787) --------- Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com>

## Description This PR resolves documentation issue with google sheets. We see learn more CTA, when creating google sheets datasource, that takes us to the documentation for google sheets. Earlier we used to show documentation using modal from omnibar, now we have[ removed the documentation option itself from omnibar](#24787), thus it started failing. This PR fixes the issue #### PR fixes following issue(s) Fixes #25005 > if no issue exists, please create an issue and ask the maintainers about this first > > #### Media > A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video > > #### Type of change - Bug fix (non-breaking change which fixes an issue) > > > ## Testing > #### How Has This Been Tested? > Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. > Delete anything that is not relevant - [x] Manual - [ ] Jest - [ ] Cypress > > #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [x] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [x] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed Co-authored-by: “sneha122” <“sneha@appsmith.com”>

This PR resolves documentation issue with google sheets. We see learn more CTA, when creating google sheets datasource, that takes us to the documentation for google sheets. Earlier we used to show documentation using modal from omnibar, now we have[ removed the documentation option itself from omnibar](#24787), thus it started failing. This PR fixes the issue Fixes #25005 > if no issue exists, please create an issue and ask the maintainers about this first > > > A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video > > - Bug fix (non-breaking change which fixes an issue) > > > > > Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. > Delete anything that is not relevant - [x] Manual - [ ] Jest - [ ] Cypress > > > Add Testsmith test cases links that relate to this PR > > > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [x] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [x] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed Co-authored-by: “sneha122” <“sneha@appsmith.com”>

Removes algolia indexing work as we will not be using this in our app anymore. [Reference](appsmithorg/appsmith#24787) --------- Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com>

hetunandu added 4 commits June 21, 2023 12:20

Remove error documentation calls to omnibar

1691745

Remove hotkey to open omnibar documentation

49eb719

Remove snippets and documentation

13797fd

Refactor

11381e5

hetunandu requested review from berzerkeer and sbalaji1192 as code owners June 23, 2023 09:56

Merge branch 'release' into sunset/docs-and-snippets

51a9318

# Conflicts: # app/client/src/components/editorComponents/WidgetQueryGeneratorForm/CommonControls/DatasourceDropdown/useDatasource.tsx

Update tests

937cf41

github-actions bot added Enhancement New feature or request IDE Product Issues related to the IDE Product IDE Pod Issues that new developers face while exploring the IDE Omnibar Issues related to the omnibar for navigation Task A simple Todo labels Jun 23, 2023

hetunandu requested a review from akash-codemonk June 23, 2023 12:51

github-actions bot added skip-changelog Adding this label to a PR prevents it from being listed in the changelog and removed Enhancement New feature or request labels Jun 23, 2023

akash-codemonk previously approved these changes Jun 23, 2023

View reviewed changes

Fix tests

569d99b

hetunandu dismissed akash-codemonk’s stale review via 569d99b June 26, 2023 05:38

github-actions bot added the Enhancement New feature or request label Jun 26, 2023

hetunandu added 2 commits June 29, 2023 13:05

Update tooltip message

bee3d84

Merge branch 'release' into sunset/docs-and-snippets

5ecfb8f

# Conflicts: # app/client/cypress/e2e/Regression/ClientSide/OtherUIFeatures/Omnibar_spec.js # app/client/src/components/editorComponents/CodeEditor/generateQuickCommands.tsx

Merge branch 'release' into sunset/docs-and-snippets

0c26b1b

hetunandu requested a review from akash-codemonk June 30, 2023 08:49

akash-codemonk approved these changes Jun 30, 2023

View reviewed changes

github-actions bot added Enhancement New feature or request and removed Enhancement New feature or request labels Jun 30, 2023

hetunandu added skip-testPlan and removed skip-changelog Adding this label to a PR prevents it from being listed in the changelog labels Jun 30, 2023

github-actions bot added the Enhancement New feature or request label Jun 30, 2023

hetunandu merged commit 02bd420 into release Jun 30, 2023

hetunandu deleted the sunset/docs-and-snippets branch June 30, 2023 10:21

sneha122 mentioned this pull request Jul 3, 2023

fix: gsheets documentation issue fixed on datasource page #25013

Merged

19 tasks

Conversation

hetunandu commented Jun 23, 2023 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

PR fixes following issue(s)

Type of change

Testing

How Has This Been Tested?

Test Plan

Issues raised during DP testing

Checklist:

Dev activity

QA activity:

Uh oh!

hetunandu commented Jun 23, 2023

Uh oh!

github-actions bot commented Jun 23, 2023

Uh oh!

github-actions bot commented Jun 23, 2023

Uh oh!

hetunandu commented Jun 23, 2023

Uh oh!

github-actions bot commented Jun 23, 2023

Uh oh!

akash-codemonk commented Jun 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

akash-codemonk commented Jun 23, 2023

Uh oh!

github-actions bot commented Jun 23, 2023

Uh oh!

github-actions bot commented Jun 23, 2023

Uh oh!

github-actions bot commented Jun 23, 2023

Uh oh!

ghost commented Jun 28, 2023 • edited by hetunandu Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hetunandu commented Jun 29, 2023

Uh oh!

github-actions bot commented Jun 29, 2023

Uh oh!

hetunandu commented Jun 29, 2023

Uh oh!

github-actions bot commented Jun 29, 2023

Uh oh!

github-actions bot commented Jun 29, 2023

Uh oh!

github-actions bot commented Jun 29, 2023

Uh oh!

hetunandu commented Jun 30, 2023

Uh oh!

github-actions bot commented Jun 30, 2023

Uh oh!

github-actions bot commented Jun 30, 2023

Uh oh!

github-actions bot commented Jun 30, 2023

Uh oh!

ghost commented Jun 30, 2023 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hetunandu commented Jun 23, 2023 •

edited by ghost

Loading

akash-codemonk commented Jun 23, 2023 •

edited

Loading

ghost commented Jun 28, 2023 •

edited by hetunandu

Loading

ghost commented Jun 30, 2023 •

edited by ghost

Loading