Skip to content

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

feat(ui): add dismissible description hints to Plan and Issue dashboards (#18875)

boojack1a3934246681
diff --git a/frontend/src/components/Project/ProjectIssuesPanel.vue b/frontend/src/components/Project/ProjectIssuesPanel.vue
index 7e5df05c63..19300466bb 100644
--- a/frontend/src/components/Project/ProjectIssuesPanel.vue
+++ b/frontend/src/components/Project/ProjectIssuesPanel.vue
@@ -1,5 +1,13 @@
<template>
<div class="flex flex-col gap-y-2">
+ <NAlert
+ v-if="!hideHint"
+ type="info"
+ closable
+ @close="dismissHint"
+ >
+ {{ $t("issue.subtitle") }}
+ </NAlert>
<IssueSearch
v-model:params="state.params"
:components="['searchbox', 'time-range', 'presets', 'status']"
@@ -25,6 +33,7 @@
</template>
<script lang="ts" setup>
+import { NAlert } from "naive-ui";
import { computed, reactive, ref, watch } from "vue";
import type { ComponentExposed } from "vue-component-type-helpers";
import { useRoute, useRouter } from "vue-router";
@@ -34,6 +43,7 @@ import {
useCurrentUserV1,
useIssueV1Store,
useRefreshIssueList,
+ useUIStateStore,
} from "@/store";
import type { ComposedIssue } from "@/types";
import {
@@ -66,6 +76,13 @@ const issueStore = useIssueV1Store();
const issuePagedTable =
ref<ComponentExposed<typeof PagedTable<ComposedIssue>>>();
+const uiStateStore = useUIStateStore();
+const HINT_KEY = "issue.hint-dismissed";
+const hideHint = computed(() => uiStateStore.getIntroStateByKey(HINT_KEY));
+const dismissHint = () => {
+ uiStateStore.saveIntroStateByKey({ key: HINT_KEY, newState: true });
+};
+
const readonlyScopes = computed((): SearchScope[] => {
return [
{
diff --git a/frontend/src/locales/en-US.json b/frontend/src/locales/en-US.json
index 3c12fd6aaf..7c88329b02 100644
--- a/frontend/src/locales/en-US.json
+++ b/frontend/src/locales/en-US.json
@@ -941,6 +941,7 @@
},
"issue": {
"labels": "Issue Labels",
+ "subtitle": "Issues cover database changes, data exports, and access requests. Review and approve before execution.",
"my-issues": "My Issues",
"waiting-approval": "Waiting for Approval",
"create-rollout": "Create Rollout",
@@ -1162,6 +1163,7 @@
},
"plan": {
"plans": "Plans",
+ "subtitle": "Draft database changes and run pre-checks before creating an issue for approval.",
"new-plan": "New Plan",
"add-spec": "Add Change",
"select-targets": "Select Targets",
diff --git a/frontend/src/locales/es-ES.json b/frontend/src/locales/es-ES.json
index 1034836bee..5e236f4149 100644
--- a/frontend/src/locales/es-ES.json
+++ b/frontend/src/locales/es-ES.json
@@ -941,6 +941,7 @@
},
"issue": {
"labels": "Etiquetas de problema",
+ "subtitle": "Los problemas abarcan cambios en la base de datos, exportaciones de datos y solicitudes de acceso. Revisar y aprobar antes de la ejecución.",
"my-issues": "Mis Incidencias",
"waiting-approval": "A la espera de la aprobación",
"create-rollout": "Crear despliegue",
@@ -1162,6 +1163,7 @@
},
"plan": {
"plans": "Planes",
+ "subtitle": "Redactar cambios en la base de datos y ejecutar comprobaciones previas antes de crear un problema para su aprobación.",
"new-plan": "Nuevo plan",
"add-spec": "Agregar especificación",
"select-targets": "Seleccionar objetivos",
diff --git a/frontend/src/locales/ja-JP.json b/frontend/src/locales/ja-JP.json
index 0f496863b1..986d932e8d 100644
--- a/frontend/src/locales/ja-JP.json
+++ b/frontend/src/locales/ja-JP.json
@@ -941,6 +941,7 @@
},
"issue": {
"labels": "イシューラベル",
+ "subtitle": "問題には、データベースの変更、データのエクスポート、アクセス要求が含まれます。実行前に確認と承認が必要です。",
"my-issues": "マイイシュー",
"waiting-approval": "承認待ち",
"create-rollout": "ロールアウトを作成",
@@ -1162,6 +1163,7 @@
},
"plan": {
"plans": "予定",
+ "subtitle": "承認のために問題を作成する前に、データベースの変更を下書きし、事前チェックを実行します。",
"new-plan": "新しい計画",
"add-spec": "仕様を追加",
"select-targets": "ターゲットを選択",
diff --git a/frontend/src/locales/vi-VN.json b/frontend/src/locales/vi-VN.json
index b74f57cb75..1a3ffad2fb 100644
--- a/frontend/src/locales/vi-VN.json
+++ b/frontend/src/locales/vi-VN.json
@@ -941,6 +941,7 @@
},
"issue": {
"labels": "Nhãn vấn đề",
+ "subtitle": "Các vấn đề bao gồm thay đổi cơ sở dữ liệu, xuất dữ liệu và yêu cầu truy cập. Cần xem xét và phê duyệt trước khi thực hiện.",
"my-issues": "Vấn đề của tôi",
"waiting-approval": "Đang chờ phê duyệt",
"create-rollout": "Tạo triển khai",
@@ -1162,6 +1163,7 @@
},
"plan": {
"plans": "Kế hoạch",
+ "subtitle": "Soạn thảo các thay đổi cơ sở dữ liệu và chạy các bước kiểm tra sơ bộ trước khi tạo vấn đề để phê duyệt.",
"new-plan": "Kế hoạch mới",
"add-spec": "Thêm thông số kỹ thuật",
"select-targets": "Chọn mục tiêu",
diff --git a/frontend/src/locales/zh-CN.json b/frontend/src/locales/zh-CN.json
index b89220f414..ae75261c8e 100644
--- a/frontend/src/locales/zh-CN.json
+++ b/frontend/src/locales/zh-CN.json
@@ -941,6 +941,7 @@
},
"issue": {
"labels": "工单标签",
+ "subtitle": "工单涵盖数据库变更、数据导出和权限申请。执行前需审查和审批。",
"my-issues": "我的工单",
"waiting-approval": "等待审批",
"create-rollout": "创建发布",
@@ -1162,6 +1163,7 @@
},
"plan": {
"plans": "变更计划",
+ "subtitle": "草拟数据库变更并运行预检查,然后创建工单以请求审批。",
"new-plan": "创建变更计划",
"add-spec": "添加变更项",
"select-targets": "选择目标库",
diff --git a/frontend/src/views/project/ProjectPlanDashboard.vue b/frontend/src/views/project/ProjectPlanDashboard.vue
index c336a70b10..182bc0f277 100644
--- a/frontend/src/views/project/ProjectPlanDashboard.vue
+++ b/frontend/src/views/project/ProjectPlanDashboard.vue
@@ -1,5 +1,14 @@
<template>
<div v-if="ready" class="w-full">
+ <NAlert
+ v-if="!hideHint"
+ type="info"
+ closable
+ class="mb-4"
+ @close="dismissHint"
+ >
+ {{ $t("plan.subtitle") }}
+ </NAlert>
<div
class="w-full flex flex-col lg:flex-row items-start lg:items-center justify-between gap-2"
>
@@ -51,7 +60,7 @@
<script lang="ts" setup>
import { head } from "lodash-es";
import { PlusIcon } from "lucide-vue-next";
-import { NButton } from "naive-ui";
+import { NAlert, NButton } from "naive-ui";
import { v4 as uuidv4 } from "uuid";
import { computed, h, reactive, ref, watch } from "vue";
import type { ComponentExposed } from "vue-component-type-helpers";
@@ -77,6 +86,7 @@ import {
useCurrentProjectV1,
useCurrentUserV1,
useStorageStore,
+ useUIStateStore,
useUserStore,
} from "@/store";
import {
@@ -108,6 +118,13 @@ const { project, ready } = useCurrentProjectV1();
const userStore = useUserStore();
const showAddSpecDrawer = ref(false);
+const uiStateStore = useUIStateStore();
+const HINT_KEY = "plan.hint-dismissed";
+const hideHint = computed(() => uiStateStore.getIntroStateByKey(HINT_KEY));
+const dismissHint = () => {
+ uiStateStore.saveIntroStateByKey({ key: HINT_KEY, newState: true });
+};
+
const readonlyScopes = computed((): SearchScope[] => {
return [];
});