From d8d20c403389ce92e5c5e659e586ebfb045a02d2 Mon Sep 17 00:00:00 2001 From: XiaoSeS <87064762+XiaoSeS@users.noreply.github.com> Date: Mon, 2 Nov 2026 16:13:31 +0800 Subject: [PATCH] docs(analytics): explicitly state one-click production deployment is pending Signed-off-by: XiaoSeS <87064762+XiaoSeS@users.noreply.github.com> --- docs/frontend-analytics-integration.md | 2 ++ docs/frontend-analytics.md | 4 +++- docs/skillhub/en/guide/frontend-analytics.md | 6 +++++- docs/skillhub/guide/frontend-analytics.md | 6 +++++- 4 files changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/frontend-analytics-integration.md b/docs/frontend-analytics-integration.md index 9d77b1ca2..594e624b0 100644 --- a/docs/frontend-analytics-integration.md +++ b/docs/frontend-analytics-integration.md @@ -3,6 +3,8 @@ ## 1. 先了解边界 +当前是手动、本地演示接入，生产一键配置尚未交付；新方案合并并验证后再更新本指南。 + SkillHub 页面只提供被动的 `data-analytics-id` 标签，默认不采集、不加载统计 SDK、不发送事件。可选 helper 把允许的原生交互转换成 `{ id, event }`，再交给部署方选择的 adapter。点击下载只表示下载意图，不表示下载、安装成功；提交发布也不表示发布成功。部署方负责授权、隐私合规、保留期限和平台安全。 本文对应 PR-1（#1010）的手工接入示例，不是产品内置开关。仅通过 Docker／Compose 或 Helm 配置开启、默认关闭和按需加载的能力计划在 PR-2 交付，见 [OpenSpec 变更](https://github.com/iflytek/skillhub/blob/main/openspec/changes/add-configurable-frontend-analytics/proposal.md)。Issue #989 要等 PR-2 完成并验证后才关闭。精确接口、事件边界和隐私约束以[英文契约][analytics-reference]为准。 diff --git a/docs/frontend-analytics.md b/docs/frontend-analytics.md index 5156ac485..fdf4b321a 100644 --- a/docs/frontend-analytics.md +++ b/docs/frontend-analytics.md @@ -4,7 +4,9 @@ For step-by-step setup, see the [Chinese integration guide][analytics-guide]. This document is the English contract reference. Configuration-only deployment is planned in [PR-2](https://github.com/iflytek/skillhub/blob/main/openspec/changes/add-configurable-frontend-analytics/proposal.md); -the current examples remain deployment-owned and opt-in. +the current examples remain deployment-owned and opt-in. They describe a manual, +local demo integration; production one-click configuration has not been delivered. +The guide will be updated after the new flow is merged and validated. SkillHub exposes semantic HTML attributes for separately maintained, optional collectors. It does not collect or send analytics by default. There is no SDK, diff --git a/docs/skillhub/en/guide/frontend-analytics.md b/docs/skillhub/en/guide/frontend-analytics.md index e344cb864..eaf48ebc4 100644 --- a/docs/skillhub/en/guide/frontend-analytics.md +++ b/docs/skillhub/en/guide/frontend-analytics.md @@ -1,6 +1,10 @@ # Frontend analytics: first local setup -This walkthrough adds a local demo entry in front of an existing SkillHub Web and verifies events stored in Umami. Collection is off by default. This is a **manual integration example**; configuration-only activation through Docker/Compose or Helm has not been merged. +This walkthrough adds a local demo entry in front of an existing SkillHub Web and verifies events stored in Umami. Collection is off by default. + +::: warning Current support scope +This page covers the delivered manual, local demo integration, not a production one-click deployment. **Production one-click configuration has not been delivered.** The new Docker/Compose and Helm configuration flow is still in progress; this page will be updated after it is merged and validated. +::: ## 1. Prepare Web and the example files diff --git a/docs/skillhub/guide/frontend-analytics.md b/docs/skillhub/guide/frontend-analytics.md index 16d95e83d..a7389dbcf 100644 --- a/docs/skillhub/guide/frontend-analytics.md +++ b/docs/skillhub/guide/frontend-analytics.md @@ -1,6 +1,10 @@ # 前端动作统计：首次本地接入 -本文带你在已有 SkillHub 前增加一个本地演示入口，连接 Umami 并确认事件入库。默认不采集；当前是**手动接入示例**，通过 Docker／Compose 或 Helm 配置直接开启的方案尚未合并。 +本文带你在已有 SkillHub 前增加一个本地演示入口，连接 Umami 并确认事件入库。SkillHub 默认不采集。 + +::: warning 当前支持范围 +本文介绍已交付的手动、本地演示接入，不是生产一键部署指南。**生产一键配置接入尚未交付**；通过 Docker／Compose 或 Helm 配置开启的新方案仍在推进，合并并完成验证后再更新本页。 +::: ## 1. 准备已有 Web 和示例文件