Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

chore(frontend): remove help drawer tip system (#19792)

Danny Xu553aee39986c
diff --git a/frontend/public/help/README.md b/frontend/public/help/README.md
deleted file mode 100644
index 24724c2dea..0000000000
--- a/frontend/public/help/README.md
+++ /dev/null
@@ -1,31 +0,0 @@
-## Help file naming rules
-
-Let's name our help files based on routes/domains, and all files should start with `help.` to indicate that it is a help doc. For example, `help.environment.md` is the help file that stands for the whole `/environment` page. If you want to create a more detailed help file to explain _Approval Policy_ under `\environment`, you can name the file to `help.environment.approval-policy.md`.
-
-If the objective of the explanation doesn't belong to any specific route/domain, we can name it with `help.global...`.
-
-## Route map configuration guide
-
-File `routeMapList.json` contains the configuration for the help system.
-
-It maps from the route name to the help document name. It lists all available route names in the whole project. If you want to add a new mapping rule, you can fill in the help name next to the route name.
-
-The format is:
-
-```json
-[
- ...,
- {
- "routeName": "write name of route here",
- "helpName": "write markdown's file name without '.md' here"
- },
- ...
-]
-```
-
-For example, `{ "routeName": "workspace.project", "helpName": "help.project" }` means let's connect the `help.project.md` file with the route `/project`.
-
-Note:
-
-1. Configs here work on all route names that are listed in `routeMapList.json`. If you want to add help in other places, please ask developers for help.
-2. Don't forget to provide markdown files in both `/en` and `/zh` directory.
diff --git a/frontend/public/help/en/help.database.md b/frontend/public/help/en/help.database.md
deleted file mode 100644
index 00c475f132..0000000000
--- a/frontend/public/help/en/help.database.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: What is 'Database' ?
----
-
-- Each Bytebase database maps to the one created by 'CREATE DATABASE xxx'. In Bytebase, a database always belongs to a single project.
-
-- Bytebase will periodically sync the database info for every recorded instance. You can also create a new database from the dashboard.
-
-#### Learn more
-
-- [Create a Project](https://docs.bytebase.com/get-started/step-by-step/create-a-project)
diff --git a/frontend/public/help/en/help.environment.md b/frontend/public/help/en/help.environment.md
deleted file mode 100644
index 0fa289de42..0000000000
--- a/frontend/public/help/en/help.environment.md
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: What is 'Environment' ?
----
-
-- Each environment maps to one of your testing, staging, prod environment respectively.
-
-- Environment is a global setting, one Bytebase deployment only contains a single set of environments.
-
-- Database instances are created under a particular environment.
-
-#### Learn more
-
-- [Set up Environments](https://docs.bytebase.com/get-started/step-by-step/set-up-environments)
diff --git a/frontend/public/help/en/help.instance.md b/frontend/public/help/en/help.instance.md
deleted file mode 100644
index 8f23259669..0000000000
--- a/frontend/public/help/en/help.instance.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: What is 'Instance' ?
----
-
-- Each Bytebase instance belongs to an environment. An instance usually maps to one of your database instance represented by an host:port address. This could be your on-premises MySQL instance or RDS instance.
-
-- Bytebase requires read/write (NOT the super privilege) access to the instance in order to perform database operations on behalf of the user.
-
-#### Learn more
-
-- [Add an Instance](https://docs.bytebase.com/get-started/step-by-step/add-an-instance)
diff --git a/frontend/public/help/en/help.issue.detail.md b/frontend/public/help/en/help.issue.detail.md
deleted file mode 100644
index 4cf464cfd0..0000000000
--- a/frontend/public/help/en/help.issue.detail.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: What is 'Issue' ?
----
-
-- Issue represents a specific collaboration activity between developer and DBA such as creating a database, altering a schema. It's similar to the issue concept in other issue management tools.
-
-#### Learn more
-
-- [Your first database change](https://docs.bytebase.com/get-started/step-by-step/change-schema)
-- [Batch change](https://docs.bytebase.com/change-database/batch-change/)
diff --git a/frontend/public/help/en/help.member.md b/frontend/public/help/en/help.member.md
deleted file mode 100644
index 81146ba22f..0000000000
--- a/frontend/public/help/en/help.member.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: What is 'Workspace Member' ?
----
-
-- You can add new members, manage their roles, and deactivate a member in the workspace.
-
-#### Learn more
-
-- [Manage Workspace Members](https://bytebase.cc/docs/get-started/step-by-step/register-accounts/#manage-members-eg-update-password)
-- [Roles and Permissions (RBAC)](https://docs.bytebase.com/administration/roles)
diff --git a/frontend/public/help/en/help.project.md b/frontend/public/help/en/help.project.md
deleted file mode 100644
index 8c02c0e18c..0000000000
--- a/frontend/public/help/en/help.project.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-title: What is 'project' ?
----
-
-- The Bytebase project shares similarities with project concepts found in other popular development tools like GitLab and Jira.
-
-- Each project has its own set of members, and every issue and database is always associated with a single project.
-
-#### Learn more
-
-- [Create a Project](https://docs.bytebase.com/get-started/step-by-step/create-a-project)
-- [UI Workflow](https://docs.bytebase.com/change-database/change-workflow)
diff --git a/frontend/public/help/ja/help.database.md b/frontend/public/help/ja/help.database.md
deleted file mode 100644
index bb61a85fb9..0000000000
--- a/frontend/public/help/ja/help.database.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: 「データベース」とは何ですか?
----
-
-- 各 Bytebase データベースは、「CREATE DATABASE xxx」によって作成されたデータベースにマップされます。 Bytebase では、データベースは常に 1 つのプロジェクトに属します。
-
-- Bytebase は、記録されたすべてのインスタンスのデータベース情報を定期的に同期します。 ダッシュボードから新しいデータベースを作成することもできます。
-
-#### さらに詳しく
-
-- [プロジェクトの作成](https://docs.bytebase.com/get-started/step-by-step/create-a-project)
diff --git a/frontend/public/help/ja/help.environment.md b/frontend/public/help/ja/help.environment.md
deleted file mode 100644
index 3102ab647a..0000000000
--- a/frontend/public/help/ja/help.environment.md
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: 「環境」とは何か?
----
-
-- 各環境はそれぞれ、テスト環境、ステージング環境、プロダクション環境のいずれかにマッピングされます。
-
-- 環境はグローバルな設定であり、1 つの Bytebase デプロイメントには 1 つの環境セットしか含まれません。
-
-- データベース・インスタンスは特定の環境下で作成される。
-
-#### Learn more
-
-- [環境の設定](https://docs.bytebase.com/get-started/step-by-step/set-up-environments)
diff --git a/frontend/public/help/ja/help.instance.md b/frontend/public/help/ja/help.instance.md
deleted file mode 100644
index ba4cd3a28b..0000000000
--- a/frontend/public/help/ja/help.instance.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: 「インスタンス」とは?
----
-
-- 各 Bytebase インスタンスは、1 つの環境に属しています。インスタンスは通常、host:port アドレスで表されるデータベースインスタンスにマッピングされます。これはオンプレミスの MySQL インスタンスまたは RDS インスタンスです。
-
-- Bytebase は、ユーザーの代わりにデータベース操作を実行するために、インスタンスへの読み取り/書き込み(スーパー権限ではない)アクセスを必要とします。
-
-#### Learn more
-
-- [インスタンスの追加](https://docs.bytebase.com/get-started/step-by-step/add-an-instance)
diff --git a/frontend/public/help/ja/help.issue.detail.md b/frontend/public/help/ja/help.issue.detail.md
deleted file mode 100644
index ebe3817e06..0000000000
--- a/frontend/public/help/ja/help.issue.detail.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: イシュー」とは何か?
----
-
-- issue は、データベースの作成やスキーマの変更など、開発者と DBA 間の特定の共同作業を表します。これは、他の課題管理ツールにおける課題の概念に似ています。
-
-#### Learn more
-
-- [初めてのデータベース変更](https://docs.bytebase.com/get-started/step-by-step/change-schema)
-- [一括変更](https://docs.bytebase.com/change-database/batch-change/)
diff --git a/frontend/public/help/ja/help.member.md b/frontend/public/help/ja/help.member.md
deleted file mode 100644
index 1e52b05494..0000000000
--- a/frontend/public/help/ja/help.member.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: ワークスペース・メンバー」とは?
----
-
-- ワークスペースでは、新しいメンバーの追加、役割の管理、およびメンバーの非アクティブ化を行うことができます。
-
-#### Learn more
-
-- [ワークスペース・メンバーの管理](https://bytebase.cc/docs/get-started/step-by-step/register-accounts/#manage-members-eg-update-password)
-- [役割と権限(RBAC)](https://docs.bytebase.com/administration/roles)
diff --git a/frontend/public/help/ja/help.project.md b/frontend/public/help/ja/help.project.md
deleted file mode 100644
index 943c50c37c..0000000000
--- a/frontend/public/help/ja/help.project.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-title: 「プロジェクト」とは何か?
----
-
-- Bytebase プロジェクトは、GitLab や Jira のような他の一般的な開発ツールに見られるプロジェクトコンセプトと共通点があります。
-
-- 各プロジェクトには独自のメンバー・セットがあり、すべての issue とデータベースは常に 1 つのプロジェクトに関連付けられています。
-
-#### さらに詳しく
-
-- [プロジェクトの作成](https://docs.bytebase.com/get-started/step-by-step/create-a-project)
-- [UI ワークフロー](https://docs.bytebase.com/change-database/change-workflow)
diff --git a/frontend/public/help/routeMapList.json b/frontend/public/help/routeMapList.json
deleted file mode 100644
index 13cf451d42..0000000000
--- a/frontend/public/help/routeMapList.json
+++ /dev/null
@@ -1,178 +0,0 @@
-[
- {
- "routeName": "auth",
- "helpName": ""
- },
- {
- "routeName": "auth.signin",
- "helpName": ""
- },
- {
- "routeName": "auth.signup",
- "helpName": ""
- },
- {
- "routeName": "auth.password.forgot",
- "helpName": ""
- },
- {
- "routeName": "oauth-callback",
- "helpName": ""
- },
- {
- "routeName": "workspace.home",
- "helpName": ""
- },
- {
- "routeName": "error.403",
- "helpName": ""
- },
- {
- "routeName": "error.404",
- "helpName": ""
- },
- {
- "routeName": "workspace.archive",
- "helpName": ""
- },
- {
- "routeName": "workspace.profile",
- "helpName": ""
- },
- {
- "routeName": "setting",
- "helpName": ""
- },
- {
- "routeName": "setting.profile",
- "helpName": ""
- },
- {
- "routeName": "setting.workspace.general",
- "helpName": ""
- },
- {
- "routeName": "setting.workspace.label",
- "helpName": ""
- },
- {
- "routeName": "setting.workspace.agent",
- "helpName": ""
- },
- {
- "routeName": "setting.workspace.project",
- "helpName": ""
- },
- {
- "routeName": "workspace.users",
- "helpName": "help.member"
- },
- {
- "routeName": "setting.workspace.subscription",
- "helpName": ""
- },
- {
- "routeName": "setting.workspace.integration.slack",
- "helpName": ""
- },
- {
- "routeName": "setting.workspace.sql-review",
- "helpName": ""
- },
- {
- "routeName": "setting.workspace.sql-review.create",
- "helpName": ""
- },
- {
- "routeName": "setting.workspace.sql-review.detail",
- "helpName": ""
- },
- {
- "routeName": "workspace.issue",
- "helpName": "help.issue.detail"
- },
- {
- "routeName": "workspace.environment",
- "helpName": "help.environment"
- },
- {
- "routeName": "workspace.environment.detail",
- "helpName": ""
- },
- {
- "routeName": "workspace.project",
- "helpName": "help.project"
- },
- {
- "routeName": "workspace.project.detail",
- "helpName": ""
- },
- {
- "routeName": "workspace.project.hook.create",
- "helpName": ""
- },
- {
- "routeName": "workspace.project.hook.detail",
- "helpName": ""
- },
- {
- "routeName": "workspace.instance",
- "helpName": "help.instance"
- },
- {
- "routeName": "workspace.database",
- "helpName": "help.database"
- },
- {
- "routeName": "workspace.database.detail",
- "helpName": ""
- },
- {
- "routeName": "workspace.database.table.detail",
- "helpName": ""
- },
- {
- "routeName": "workspace.instance.detail",
- "helpName": ""
- },
- {
- "routeName": "workspace.issue.detail",
- "helpName": "help.issue.detail"
- },
- {
- "routeName": "sql-editor",
- "helpName": ""
- },
- {
- "routeName": "sql-editor.home",
- "helpName": ""
- },
- {
- "routeName": "sql-editor.legacy-detail",
- "helpName": ""
- },
- {
- "routeName": "sql-editor.legacy-share",
- "helpName": ""
- },
- {
- "routeName": "sheets",
- "helpName": ""
- },
- {
- "routeName": "sheets.dashboard",
- "helpName": ""
- },
- {
- "routeName": "sheets.my",
- "helpName": ""
- },
- {
- "routeName": "sheets.shared",
- "helpName": ""
- },
- {
- "routeName": "sheets.starred",
- "helpName": ""
- }
-]
diff --git a/frontend/public/help/zh/help.database.md b/frontend/public/help/zh/help.database.md
deleted file mode 100644
index d4ac738729..0000000000
--- a/frontend/public/help/zh/help.database.md
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: 什么是「数据库」?
----
-
-- 每个 Bytebase 数据库都映射到由「CREATE DATABASE xxx」创建的一个数据库。
-
-- 在 Bytebase 中,一个数据库始终属于单个项目。Bytebase 将定期同步每个实例的数据库信息。
-
-- 您还可以从仪表板创建新数据库。
-
-#### 了解更多
-
-- [建立一个项目](https://docs.bytebase.com/get-started/step-by-step/create-a-project)
diff --git a/frontend/public/help/zh/help.environment.md b/frontend/public/help/zh/help.environment.md
deleted file mode 100644
index 20ae33867c..0000000000
--- a/frontend/public/help/zh/help.environment.md
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: 什么是「环境」?
----
-
-- 每个环境与您的诸如测试,预发,生产环境一一对应。
-
-- 环境是一个全局配置,一套 Bytebase 的部署也只包含一套环境配置的集合。
-
-- 数据库实例是创建在某个特定环境下面的。
-
-#### 了解更多
-
-- [配置一个环境](https://docs.bytebase.com/get-started/step-by-step/set-up-environments)
diff --git a/frontend/public/help/zh/help.instance.md b/frontend/public/help/zh/help.instance.md
deleted file mode 100644
index bc8d40da06..0000000000
--- a/frontend/public/help/zh/help.instance.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-title: 什么是「实例」?
----
-
-- 每个 Bytebase 实例属于一个环境。一个实例通常映射到您的一个由 host:port 地址所代表的数据库实例。这可能是您在诸如 AWS 上的
- RDS 实例,也可能是您私有化部署的 MySQL 实例。
-
-- Bytebase 要求实例的读写权限(而不是 super 权限)以代表用户执行数据库操作。
-
-#### 了解更多
-
-- [添加实例](https://docs.bytebase.com/get-started/step-by-step/add-an-instance)
diff --git a/frontend/public/help/zh/help.issue.detail.md b/frontend/public/help/zh/help.issue.detail.md
deleted file mode 100644
index 8e9363e56d..0000000000
--- a/frontend/public/help/zh/help.issue.detail.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: 什么是「工单」 ?
----
-
-- 「工单」代表了开发人员和 DBA 之间的合作活动,如创建数据库,改变 schema。它类似于其他管理工具中的工单概念。
-
-#### 了解更多
-
-- [您的一个数据库变更](https://docs.bytebase.com/get-started/step-by-step/change-schema)
-- [批量变更](https://docs.bytebase.com/change-database/batch-change/)
diff --git a/frontend/public/help/zh/help.member.md b/frontend/public/help/zh/help.member.md
deleted file mode 100644
index 4c255efca3..0000000000
--- a/frontend/public/help/zh/help.member.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: 什么是「空间成员」 ?
----
-
-- 您可以添加新的成员,管理他们的角色,并在工作空间上停用某个成员。
-
-#### Learn more
-
-- [管理成员](https://bytebase.cc/docs/get-started/step-by-step/register-accounts/#manage-members-eg-update-password)
-- [角色和权限 RBAC](https://docs.bytebase.com/administration/roles)
diff --git a/frontend/public/help/zh/help.project.md b/frontend/public/help/zh/help.project.md
deleted file mode 100644
index 1631c53d7d..0000000000
--- a/frontend/public/help/zh/help.project.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-title: 什么是「项目」 ?
----
-
-- Bytebase 项目与其他流行的开发工具如 GitLab 和 Jira 中找到的项目概念有相似之处。
-
-- 每个项目都有自己的成员组。每个工单和数据库始终与单个项目关联。
-
-#### 了解更多
-
-- [建立一个项目](https://docs.bytebase.com/get-started/step-by-step/create-a-project)
-- [UI 工作流](https://docs.bytebase.com/change-database/change-workflow)
diff --git a/frontend/src/components/HelpDrawer/HelpDrawer.vue b/frontend/src/components/HelpDrawer/HelpDrawer.vue
deleted file mode 100644
index 151f263ea0..0000000000
--- a/frontend/src/components/HelpDrawer/HelpDrawer.vue
+++ /dev/null
@@ -1,165 +0,0 @@
-<template>
- <Drawer
- :show="active"
- class="w-96! max-w-full"
- :close-on-esc="true"
- @update:show="(show: boolean) => !show && onClose()"
- >
- <DrawerContent
- class="w-full"
- :title="state.frontmatter.title"
- :closable="true"
- >
- <!-- eslint-disable-next-line vue/no-v-html -->
- <div v-if="state.html" class="overflow-auto" v-html="state.html"></div>
- <template #footer>
- <div class="flex flex-col items-center gap-y-4 pb-10">
- <NButton
- v-if="isGuide"
- text
- size="small"
- @click="onDismissAll"
- >
- {{ $t("help-drawer.dont-show-again") }}
- </NButton>
- </div>
- </template>
- </DrawerContent>
- </Drawer>
-</template>
-
-<script lang="ts" setup>
-import type { Node, Tag } from "@markdoc/markdoc";
-import { NButton } from "naive-ui";
-import { storeToRefs } from "pinia";
-import { computed, reactive, ref, watch } from "vue";
-import { useRoute } from "vue-router";
-import { Drawer, DrawerContent } from "@/components/v2";
-import { useLanguage } from "@/composables/useLanguage";
-import { useHelpStore, useUIStateStore } from "@/store";
-import type { RouteMapList } from "@/types";
-
-const [
- { default: Markdoc },
- { markdocConfig, DOMPurifyConfig },
- { default: yaml },
- { default: DOMPurify },
-] = await Promise.all([
- import("@markdoc/markdoc"),
- import("./config"),
- import("js-yaml"),
- import("dompurify"),
-]);
-
-interface State {
- frontmatter: Record<string, string>;
- html: string;
- helpTimer: number | undefined;
- RouteMapList: RouteMapList | null;
-}
-
-const active = ref(false);
-const { locale } = useLanguage();
-const uiStateStore = useUIStateStore();
-const helpStore = useHelpStore();
-const helpStoreState = storeToRefs(helpStore);
-const route = useRoute();
-
-const helpId = computed(() => helpStoreState.currHelpId.value);
-const isGuide = computed(() => helpStoreState.openByDefault.value);
-
-const state = reactive<State>({
- frontmatter: {},
- html: "",
- helpTimer: undefined,
- RouteMapList: null,
-});
-
-// watch route change for help
-watch(
- () => route.name,
- async (routeName) => {
- const uiStateStore = useUIStateStore();
- const helpStore = useHelpStore();
-
- // Clear timer after every route change.
- if (state.helpTimer) {
- clearTimeout(state.helpTimer);
- state.helpTimer = undefined;
- }
-
- // Hide opened help drawer if route changed.
- helpStore.exitHelp();
-
- if (!state.RouteMapList) {
- const res = await fetch("/help/routeMapList.json");
- state.RouteMapList = await res.json();
- }
-
- const helpId = state.RouteMapList?.find(
- (pair) => pair.routeName === routeName
- )?.helpName;
-
- if (
- helpId &&
- !uiStateStore.allHelpDrawersDismissed &&
- !uiStateStore.getIntroStateByKey(`${helpId}`)
- ) {
- state.helpTimer = window.setTimeout(() => {
- helpStore.showHelp(helpId, true);
- uiStateStore.saveIntroStateByKey({
- key: `${helpId}`,
- newState: true,
- });
- }, 500);
- }
- }
-);
-
-watch(helpId, async (id) => {
- if (id) {
- const res = await fetch(
- `/help/${
- locale.value === "zh-CN" ? "zh" : locale.value === "ja-JP" ? "ja" : "en"
- }/${id}.md`
- );
- const markdown = await res.text();
- const ast: Node = Markdoc.parse(markdown);
- const content = Markdoc.transform(ast, markdocConfig) as Tag;
-
- content.attributes.class = "markdown-body"; // style help content
- const html: string = Markdoc.renderers.html(content);
-
- state.frontmatter = ast.attributes.frontmatter
- ? (yaml.load(ast.attributes.frontmatter) as Record<string, string>)
- : {};
- state.html = DOMPurify.sanitize(html, DOMPurifyConfig);
- activate();
- } else {
- state.frontmatter = {};
- state.html = "";
- deactivate();
- }
-});
-
-const onDismissAll = () => {
- uiStateStore.allHelpDrawersDismissed = true;
- helpStore.exitHelp();
-};
-
-const onClose = () => {
- if (isGuide.value) {
- if (!uiStateStore.getIntroStateByKey(`${helpId.value}`)) {
- uiStateStore.saveIntroStateByKey({
- key: `${helpId.value}`,
- newState: true,
- });
- }
- }
- helpStore.exitHelp();
-};
-
-const activate = () => (active.value = true);
-
-const deactivate = () => (active.value = false);
-</script>
diff --git a/frontend/src/components/HelpDrawer/config.ts b/frontend/src/components/HelpDrawer/config.ts
deleted file mode 100644
index 56e3327d9a..0000000000
--- a/frontend/src/components/HelpDrawer/config.ts
+++ /dev/null
@@ -1,23 +0,0 @@
-import { type Config, type Node, type Schema, Tag } from "@markdoc/markdoc";
-
-export const markdocConfig: { nodes: Record<string, Schema> } = {
- nodes: {
- link: {
- render: "a",
- attributes: {
- href: { type: String, required: true },
- target: { type: String, default: "_blank" },
- },
- transform(node: Node, config: Config) {
- const attributes = node.transformAttributes(config);
- const children = node.transformChildren(config);
- Object.assign(attributes, { target: "_blank" });
- return new Tag("a", attributes, children);
- },
- },
- },
-};
-
-export const DOMPurifyConfig = {
- ADD_ATTR: ["target"],
-};
diff --git a/frontend/src/components/HelpDrawer/index.ts b/frontend/src/components/HelpDrawer/index.ts
deleted file mode 100644
index e750fa3d9b..0000000000
--- a/frontend/src/components/HelpDrawer/index.ts
+++ /dev/null
@@ -1,3 +0,0 @@
-import HelpDrawer from "./HelpDrawer.vue";
-
-export default HelpDrawer;
diff --git a/frontend/src/components/HelpTriggerIcon.vue b/frontend/src/components/HelpTriggerIcon.vue
deleted file mode 100644
index 2150c2f406..0000000000
--- a/frontend/src/components/HelpTriggerIcon.vue
+++ /dev/null
@@ -1,18 +0,0 @@
-<template>
- <HelpCircleIcon class="w-4 h-4 cursor-pointer" @click="handleClick" />
-</template>
-
-<script lang="ts" setup>
-import { HelpCircleIcon } from "lucide-vue-next";
-import { useHelpStore } from "@/store";
-
-const props = defineProps<{
- id: string;
- openByDefault?: boolean;
-}>();
-
-const helpStore = useHelpStore();
-const handleClick = () => {
- helpStore.showHelp(props.id, props.openByDefault);
-};
-</script>
diff --git a/frontend/src/components/ProfileDropdown.vue b/frontend/src/components/ProfileDropdown.vue
index e52069f188..4c7ad1afad 100644
--- a/frontend/src/components/ProfileDropdown.vue
+++ b/frontend/src/components/ProfileDropdown.vue
@@ -26,7 +26,6 @@ import { WORKSPACE_ROUTE_LANDING } from "@/router/dashboard/workspaceRoutes";
import { SQL_EDITOR_HOME_MODULE } from "@/router/sqlEditor";
import {
useActuatorV1Store,
- useAppFeature,
useAuthStore,
useCurrentUserV1,
useSubscriptionV1Store,
@@ -52,7 +51,6 @@ const uiStateStore = useUIStateStore();
const { setLocale, locale } = useLanguage();
const currentUserV1 = useCurrentUserV1();
const showDropdown = ref(false);
-const hideHelp = useAppFeature("bb.feature.hide-help");
const { currentPlan } = storeToRefs(subscriptionStore);
@@ -70,12 +68,6 @@ const resetQuickstart = () => {
"database.visit",
"member.visit",
"data.query",
- "help.issue.detail",
- "help.project",
- "help.environment",
- "help.instance",
- "help.database",
- "help.member",
];
keys.forEach((key) => {
uiStateStore.saveIntroStateByKey({
@@ -263,22 +255,6 @@ const options = computed((): DropdownOption[] => [
);
},
},
- {
- key: "help",
- type: "render",
- show: !hideHelp.value,
- render() {
- return (
- <a
- class="menu-item"
- target="_blank"
- href="https://docs.bytebase.com/introduction/what-is-bytebase/?source=console"
- >
- {t("common.help")}
- </a>
- );
- },
- },
{
key: "sql-editor",
type: "render",
diff --git a/frontend/src/customAppProfile.ts b/frontend/src/customAppProfile.ts
index cfd4f61198..f3599f2476 100644
--- a/frontend/src/customAppProfile.ts
+++ b/frontend/src/customAppProfile.ts
@@ -33,7 +33,6 @@ const overrideAppFeatures = () => {
if (databaseChangeMode.value === DatabaseChangeMode.EDITOR) {
actuatorStore.overrideAppFeatures({
"bb.feature.hide-quick-start": true,
- "bb.feature.hide-help": true,
"bb.feature.hide-trial": true,
});
}
diff --git a/frontend/src/layouts/DashboardLayout.vue b/frontend/src/layouts/DashboardLayout.vue
index e8d68d9c17..1f6510beac 100644
--- a/frontend/src/layouts/DashboardLayout.vue
+++ b/frontend/src/layouts/DashboardLayout.vue
@@ -9,17 +9,10 @@
</ProvideDashboardContext>
</template>
</Suspense>
- <Suspense v-if="!hideHelp">
- <HelpDrawer />
- </Suspense>
</div>
</template>
<script lang="ts" setup>
import BannersWrapper from "@/components/BannersWrapper.vue";
-import HelpDrawer from "@/components/HelpDrawer";
import ProvideDashboardContext from "@/components/ProvideDashboardContext.vue";
-import { useAppFeature } from "@/store";
-
-const hideHelp = useAppFeature("bb.feature.hide-help");
</script>
diff --git a/frontend/src/locales/en-US.json b/frontend/src/locales/en-US.json
index 4881cf919d..543ca1adce 100644
--- a/frontend/src/locales/en-US.json
+++ b/frontend/src/locales/en-US.json
@@ -31,7 +31,6 @@
"settings": "Settings",
"project": "Project",
"projects": "Projects",
- "help": "Help",
"database": "Database",
"databases": "Databases",
"description": "Description",
@@ -2993,9 +2992,6 @@
"permission-access": "Access your Bytebase account with your permissions"
}
},
- "help-drawer": {
- "dont-show-again": "Don't show these tips again"
- },
"agent": {
"assistant-title": "Bytebase Assistant",
"self": "Agent",
diff --git a/frontend/src/locales/es-ES.json b/frontend/src/locales/es-ES.json
index ce543b72d6..6f203ed14a 100644
--- a/frontend/src/locales/es-ES.json
+++ b/frontend/src/locales/es-ES.json
@@ -31,7 +31,6 @@
"settings": "Configuraciones",
"project": "Proyecto",
"projects": "Proyectos",
- "help": "Ayuda",
"database": "Base de datos",
"databases": "Bases de datos",
"description": "Descripción",
@@ -3049,8 +3048,5 @@
"permissions": "Esta aplicación podrá:",
"permission-access": "Acceder a tu cuenta de Bytebase con tus permisos"
}
- },
- "help-drawer": {
- "dont-show-again": "No mostrar estos consejos de nuevo"
}
}
diff --git a/frontend/src/locales/ja-JP.json b/frontend/src/locales/ja-JP.json
index 92fdd9bd8a..fa7647e3af 100644
--- a/frontend/src/locales/ja-JP.json
+++ b/frontend/src/locales/ja-JP.json
@@ -31,7 +31,6 @@
"settings": "設定",
"project": "プロジェクト",
"projects": "プロジェクト",
- "help": "ヘルプ",
"database": "データベース",
"databases": "データベース",
"description": "説明",
@@ -3049,8 +3048,5 @@
"permissions": "このアプリケーションは以下のことができます:",
"permission-access": "あなたの権限で Bytebase アカウントにアクセス"
}
- },
- "help-drawer": {
- "dont-show-again": "これらのヒントを再度表示しない"
}
}
diff --git a/frontend/src/locales/vi-VN.json b/frontend/src/locales/vi-VN.json
index 07adf5911a..d390d73901 100644
--- a/frontend/src/locales/vi-VN.json
+++ b/frontend/src/locales/vi-VN.json
@@ -31,7 +31,6 @@
"settings": "Cài đặt",
"project": "Dự án",
"projects": "Dự án",
- "help": "Trợ giúp",
"database": "Cơ sở dữ liệu",
"databases": "Cơ sở dữ liệu",
"description": "Mô tả",
@@ -3049,8 +3048,5 @@
"permissions": "Ứng dụng này sẽ có thể:",
"permission-access": "Truy cập tài khoản Bytebase của bạn với quyền hạn của bạn"
}
- },
- "help-drawer": {
- "dont-show-again": "Không hiển thị các mẹo này nữa"
}
}
diff --git a/frontend/src/locales/zh-CN.json b/frontend/src/locales/zh-CN.json
index e5a247e382..3209084efe 100644
--- a/frontend/src/locales/zh-CN.json
+++ b/frontend/src/locales/zh-CN.json
@@ -31,7 +31,6 @@
"settings": "设置",
"project": "项目",
"projects": "项目",
- "help": "帮助",
"database": "数据库",
"databases": "数据库",
"description": "描述",
@@ -2993,9 +2992,6 @@
"permission-access": "使用您的权限访问您的 Bytebase 账户"
}
},
- "help-drawer": {
- "dont-show-again": "不再显示这些提示"
- },
"agent": {
"assistant-title": "Bytebase 助手",
"self": "助手",
diff --git a/frontend/src/store/modules/help.ts b/frontend/src/store/modules/help.ts
deleted file mode 100644
index 2ea9b1035c..0000000000
--- a/frontend/src/store/modules/help.ts
+++ /dev/null
@@ -1,23 +0,0 @@
-import { defineStore } from "pinia";
-
-export const useHelpStore = defineStore("help", {
- state: (): {
- currHelpId: string;
- openByDefault: boolean;
- } => {
- return {
- currHelpId: "",
- openByDefault: false,
- };
- },
- actions: {
- showHelp(id: string, openByDefault: boolean): void {
- this.currHelpId = id;
- this.openByDefault = openByDefault;
- },
- exitHelp() {
- this.currHelpId = "";
- this.openByDefault = false;
- },
- },
-});
diff --git a/frontend/src/store/modules/index.ts b/frontend/src/store/modules/index.ts
index 884b8af3c1..dd9b58dd9c 100644
--- a/frontend/src/store/modules/index.ts
+++ b/frontend/src/store/modules/index.ts
@@ -1,6 +1,5 @@
export * from "./accessGrant";
export * from "./v1/auth";
-export * from "./help";
export * from "./notification";
export * from "./router";
export * from "./sqlEditor";
diff --git a/frontend/src/store/modules/uistate.ts b/frontend/src/store/modules/uistate.ts
index 263c7f7359..44d4f3b952 100644
--- a/frontend/src/store/modules/uistate.ts
+++ b/frontend/src/store/modules/uistate.ts
@@ -1,9 +1,7 @@
-import { useLocalStorage } from "@vueuse/core";
import { defineStore } from "pinia";
import { computed } from "vue";
import { useCurrentUserV1 } from "@/store";
import {
- STORAGE_KEY_HELP_DRAWERS_DISMISSED,
storageKeyCollapseState,
storageKeyIntroState,
useDynamicLocalStorage,
@@ -22,11 +20,6 @@ export const useUIStateStore = defineStore("uistate", () => {
{}
);
- const allHelpDrawersDismissed = useLocalStorage(
- STORAGE_KEY_HELP_DRAWERS_DISMISSED,
- false
- );
-
const getIntroStateByKey = (key: string): boolean => {
return introState.value[key] ?? false;
};
@@ -47,7 +40,6 @@ export const useUIStateStore = defineStore("uistate", () => {
};
return {
- allHelpDrawersDismissed,
collapseState,
introState,
saveIntroStateByKey,
diff --git a/frontend/src/types/appProfile.ts b/frontend/src/types/appProfile.ts
index a26c3900df..5b46148eef 100644
--- a/frontend/src/types/appProfile.ts
+++ b/frontend/src/types/appProfile.ts
@@ -5,7 +5,6 @@ export type AppFeatures = {
"bb.feature.database-change-mode":
| DatabaseChangeMode.PIPELINE
| DatabaseChangeMode.EDITOR;
- "bb.feature.hide-help": boolean;
"bb.feature.hide-quick-start": boolean;
"bb.feature.hide-trial": boolean;
};
@@ -17,7 +16,6 @@ export type AppProfile = {
export const defaultAppProfile = (): AppProfile => ({
features: {
"bb.feature.database-change-mode": DatabaseChangeMode.PIPELINE,
- "bb.feature.hide-help": false,
"bb.feature.hide-quick-start": false,
"bb.feature.hide-trial": false,
},
diff --git a/frontend/src/types/help.ts b/frontend/src/types/help.ts
deleted file mode 100644
index a54edccdde..0000000000
--- a/frontend/src/types/help.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-export type RouteMap = {
- routeName: string;
- helpName: string;
-};
-
-export type RouteMapList = RouteMap[];
diff --git a/frontend/src/types/index.ts b/frontend/src/types/index.ts
index 67720c82ba..a1db6ecc94 100644
--- a/frontend/src/types/index.ts
+++ b/frontend/src/types/index.ts
@@ -6,7 +6,6 @@ export * from "./const";
export * from "./dataSource";
export * from "./dbGroup";
export * from "./error";
-export * from "./help";
export * from "./iam";
export * from "./id";
export * from "./member";
diff --git a/frontend/src/utils/storage-keys.ts b/frontend/src/utils/storage-keys.ts
index 6ad01832b1..2e8c02b7c5 100644
--- a/frontend/src/utils/storage-keys.ts
+++ b/frontend/src/utils/storage-keys.ts
@@ -11,8 +11,6 @@ export const STORAGE_KEY_SCHEMA_EDITOR_PREVIEW =
export const STORAGE_KEY_ROLES_EXPIRATION =
"bb.roles.last-expiration-selection";
export const STORAGE_KEY_AI_DISMISS = "bb.ai.dismiss-placeholder";
-export const STORAGE_KEY_HELP_DRAWERS_DISMISSED =
- "bb.help-drawers.all-dismissed";
export const STORAGE_KEY_SQL_EDITOR_RESULT_LIMIT = "bb.sql-editor.result-limit";
export const STORAGE_KEY_SQL_EDITOR_REDIS_NODE = "bb.sql-editor.redis-node";
export const STORAGE_KEY_SQL_EDITOR_LAST_PROJECT = "bb.sql-editor.last-project";