PromucFlow_constructor/app/client/src/constants/DocumentationLinks.ts
Hetu Nandu 02bd42003a
chore: Sunset Omnibar Documentation and Snippets (#24787)
## 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?

- [x] Manual
- [x] Cypress

#### Test Plan

https://github.com/appsmithorg/appsmith/pull/24787#issuecomment-1611180354

#### Issues raised during DP testing

https://github.com/appsmithorg/appsmith/pull/24787#issuecomment-1611475323

## 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:
- [x] [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-)
- [x] Test plan has been peer reviewed by project stakeholders and other
QA members
- [x] Manually tested functionality on DP
- [x] We had an implementation alignment call with stakeholders post QA
Round 2
- [x] 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
2023-06-30 15:51:08 +05:30

32 lines
1.1 KiB
TypeScript

import AnalyticsUtil from "../utils/AnalyticsUtil";
export enum DocsLink {
CAPTURE_DATA = "CAPTURE_DATA",
WHITELIST_IP = "WHITELIST_IP",
CONNECT_DATA = "CONNECT_DATA",
QUERY = "QUERY",
TROUBLESHOOT_ERROR = "TROUBLESHOOT_ERROR",
}
const LinkData: Record<DocsLink, string> = {
CONNECT_DATA:
"https://docs.appsmith.com/core-concepts/connecting-to-data-sources",
QUERY:
"https://docs.appsmith.com/core-concepts/connecting-to-data-sources#docusaurus_skipToContent_fallback",
WHITELIST_IP:
"https://docs.appsmith.com/core-concepts/connecting-to-data-sources/connecting-to-databases",
CAPTURE_DATA:
"https://docs.appsmith.com/core-concepts/data-access-and-binding/capturing-data-write",
TROUBLESHOOT_ERROR:
"https://docs.appsmith.com/help-and-support/troubleshooting-guide",
};
export const openDoc = (type: DocsLink, link?: string, subType?: string) => {
let linkToOpen = LinkData[type];
if (link && link.length) {
linkToOpen = link;
}
AnalyticsUtil.logEvent("OPEN_DOCS", { source: type, queryType: subType });
window.open(linkToOpen, "_blank");
};