docs: terminology, label and link cleanup across the docs (#901) (backport to release/1.16.1) - #909
Open
RiskeyL wants to merge 1 commit into
Open
docs: terminology, label and link cleanup across the docs (#901) (backport to release/1.16.1)#909RiskeyL wants to merge 1 commit into
RiskeyL wants to merge 1 commit into
Conversation
* docs: add the self-host prerequisite to the CLI pages difyctl login 404s on a default self-hosted deployment because the /openapi/v1/* surface ships disabled, and with only OPENAPI_ENABLED it 503s at approval. Name both flags before the sign-in steps. Dify Cloud is unaffected. Also fixes six pre-existing blank-line violations after code fences in the same pages. * docs: complete the Integration Trigger rename in ja The ja tree rendered the node as 統合トリガー in 27 places across 9 files, while the product UI calls it インテグレーショントリガー. Adopt the UI string. No inbound links pointed at the four headings whose anchors move. * fix: repoint contact-sales links to the per-language forms Enterprise Tips still linked the udify.app webapp. Point each language at its own HubSpot sales form, per writing-guides/style-guide.md. The udify.app/chat/abc123 placeholder in user-input.mdx is untouched. * fix: correct card icons that never rendered icon="scale" and icon="arrows-exchange" are not FontAwesome 6 names, so the Legal Pages and Import & Export cards rendered with no icon at all. Use scale-balanced and right-left. * docs: use 应用 instead of 应用程序 in the zh docs The glossary term for app is 应用. 191 occurrences of 应用程序 remained, mostly in the monitor, workspace and publish trees. The zh UI is itself split between the two, so this follows the glossary rather than the UI. * fix: align UI labels and formatting with the product Max Iterations on the Agent node matched the classic Agent app setting instead of the node's own label; the ja column said 最大反復数 where the UI says 最大反復回数. The Run Batch tab was バッチ実行 in a ja tutorial and Batch Run in en. The tool YAML type list documented 6 of the 14 values ToolParameterType accepts. Three zh Frame captions disagreed with their alt text. * docs: standardize the web app term across all three languages Use web app / Web 应用 / Web アプリ, lowercase in English body text and capitalized where a sentence, description or title-case caption starts. The product UI is split across web app, Web App and WebApp in every language, so there is no UI spelling to follow; the glossary now carries the rule. zh also had a third variant, 网页应用, and ja had four missing CJK-Latin spaces. On-screen labels stay verbatim: Web App Access Control, the Web App publish-panel section, Who can access web app. So do the API identifiers Get App WebApp Settings, whose published slug 18 files link to, plus getChatWebAppSettings and WebAppSettingsResponse. The webapp family pages carry their other fixes in this commit too, since those edits interleave with the term change line by line. * fix: address review feedback on terminology and frontmatter Make "web app" plural in the cheatsheet so it parallels "Endpoints" in the same list. Close the zh lesson-10 parenthesis with the full-width mark it was opened with. Add the missing zh description on both chatflow-webapp pages, where en and ja already had one. The other four review comments asked for descriptions on pages whose en source also lacks one. Those are not translation gaps; they belong to the tree-wide frontmatter pass tracked as DC-58. * fix: match AI credits to the casing the product uses The UI renders the label lowercase (modelProvider.card.aiCreditsOption and selector.aiCredits); only the section header quotaLabel is all-caps. Lowercase the term in body prose and in the model-providers description, and leave the two Title Case headings alone. Safe on every branch this backports to: the capitalized modelProvider.quota was pruned upstream in the commit first tagged 1.15.0, so 1.15.0 through 1.16.1 all carry the same lowercase strings. (cherry picked from commit 134e075)
dosubot
Bot
added
size:L
Contributor
There was a problem hiding this comment.
🟡 Not ready to approve
Two typos (“准确的的”) remain in modified Chinese knowledge-base management pages and should be corrected before merging.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR backports documentation cleanups from main to release/1.16.1, focusing on consistent terminology (especially “app” / “Web app”), UI label alignment, and correcting outdated links/icons across the English, Chinese, and Japanese docs.
Changes:
- Standardize terminology and UI labels across en/zh/ja docs (e.g., “Web app”, “Max Iterations”, “Run Batch”, 应用 vs 应用程序, インテグレーショントリガー).
- Fix or update doc assets and references (HubSpot contact-sales links, FontAwesome icon names, “Embed Into Site/嵌入网站” navigation text).
- Add self-host prerequisites for CLI login (
OPENAPI_ENABLED+ENABLE_OAUTH_BEARER) to CLI quick-start/auth pages.
File summaries
| File | Description |
|---|---|
| zh/self-host/use-dify/workspace/team-members-management.mdx | 应用术语统一 |
| zh/self-host/use-dify/workspace/readme.mdx | 联系销售链接更新；术语统一 |
| zh/self-host/use-dify/workspace/plugins.mdx | 联系销售链接更新 |
| zh/self-host/use-dify/workspace/personal-account-management.mdx | 联系销售链接更新；术语统一 |
| zh/self-host/use-dify/workspace/app-management.mdx | 图标修复；术语统一；Web 应用表述统一 |
| zh/self-host/use-dify/publish/webapp/workflow-webapp.mdx | Web 应用文案与列表格式统一 |
| zh/self-host/use-dify/publish/webapp/web-app-settings.mdx | 图标修复；术语统一；联系销售链接更新 |
| zh/self-host/use-dify/publish/webapp/embedding-in-websites.mdx | “嵌入网站”导航名更新；章节重排 |
| zh/self-host/use-dify/publish/webapp/chatflow-webapp.mdx | Web 应用术语统一；补充描述 |
| zh/self-host/use-dify/publish/publish-mcp.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/use-dify/nodes/user-input.mdx | Web 应用术语统一 |
| zh/self-host/use-dify/nodes/human-input.mdx | Web 应用术语统一 |
| zh/self-host/use-dify/nodes/doc-extractor.mdx | 术语精简（应用程序→应用） |
| zh/self-host/use-dify/nodes/agent.mdx | Frame caption 空格规范化 |
| zh/self-host/use-dify/monitor/logs.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/use-dify/monitor/integrations/integrate-weave.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/use-dify/monitor/integrations/integrate-phoenix.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/use-dify/monitor/integrations/integrate-opik.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/use-dify/monitor/integrations/integrate-langsmith.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/use-dify/monitor/integrations/integrate-langfuse.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/use-dify/monitor/integrations/integrate-arize.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/use-dify/monitor/analysis.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base.mdx | “应用程序”→“应用”术语统一（含需修正错字） |
| zh/self-host/use-dify/getting-started/introduction.mdx | Web 应用术语统一 |
| zh/self-host/use-dify/build/text-generator.mdx | Web 应用术语统一 |
| zh/self-host/use-dify/build/additional-features.mdx | Web 应用 caption 统一 |
| zh/self-host/deploy/troubleshooting/weaviate-v4-migration.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/deploy/troubleshooting/integrations.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/deploy/troubleshooting/docker-issues.mdx | Web 应用术语统一 |
| zh/self-host/deploy/troubleshooting/common-issues.mdx | Web 应用术语统一；小标题术语统一 |
| zh/self-host/deploy/platform-guides/dify-premium.mdx | “应用程序”→“应用”术语统一 |
| zh/self-host/deploy/overview.mdx | 联系销售链接更新 |
| zh/self-host/deploy/configuration/environments.mdx | Web 应用术语统一（APP_* 说明） |
| zh/quick-start.mdx | “应用程序”→“应用”术语统一 |
| zh/learn/tutorials/workflow-101/lesson-10.mdx | Web 应用术语统一；批量运行标签说明强化 |
| zh/learn/key-concepts.mdx | “应用程序”→“应用”术语统一（变量表） |
| zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin.mdx | tool 参数 type 取值列表补全说明 |
| zh/develop-plugin/dev-guides-and-walkthroughs/tool-oauth.mdx | “应用程序”→“应用”术语统一 |
| zh/develop-plugin/dev-guides-and-walkthroughs/cheatsheet.mdx | Web 应用术语统一 |
| zh/cloud/use-dify/workspace/readme.mdx | 应用术语统一 |
| zh/cloud/use-dify/workspace/personal-account-management.mdx | 应用术语统一 |
| zh/cloud/use-dify/workspace/app-management.mdx | 图标修复；术语统一；Web 应用表述统一 |
| zh/cloud/use-dify/publish/webapp/workflow-webapp.mdx | Web 应用文案与列表格式统一 |
| zh/cloud/use-dify/publish/webapp/web-app-settings.mdx | 图标修复；术语统一 |
| zh/cloud/use-dify/publish/webapp/web-app-access.mdx | Frontmatter/翻译提示格式统一；术语与 UI 路径对齐 |
| zh/cloud/use-dify/publish/webapp/embedding-in-websites.mdx | “嵌入网站”导航名更新；章节重排 |
| zh/cloud/use-dify/publish/webapp/chatflow-webapp.mdx | Web 应用术语统一；补充描述 |
| zh/cloud/use-dify/publish/publish-mcp.mdx | “应用程序”→“应用”术语统一 |
| zh/cloud/use-dify/nodes/user-input.mdx | Web 应用术语统一 |
| zh/cloud/use-dify/nodes/human-input.mdx | Web 应用术语统一 |
| zh/cloud/use-dify/nodes/doc-extractor.mdx | 术语精简（应用程序→应用） |
| zh/cloud/use-dify/nodes/agent.mdx | Frame caption 空格规范化 |
| zh/cloud/use-dify/monitor/logs.mdx | “应用程序”→“应用”术语统一 |
| zh/cloud/use-dify/monitor/integrations/integrate-weave.mdx | “应用程序”→“应用”术语统一 |
| zh/cloud/use-dify/monitor/integrations/integrate-phoenix.mdx | “应用程序”→“应用”术语统一 |
| zh/cloud/use-dify/monitor/integrations/integrate-opik.mdx | “应用程序”→“应用”术语统一 |
| zh/cloud/use-dify/monitor/integrations/integrate-langsmith.mdx | “应用程序”→“应用”术语统一 |
| zh/cloud/use-dify/monitor/integrations/integrate-langfuse.mdx | “应用程序”→“应用”术语统一 |
| zh/cloud/use-dify/monitor/integrations/integrate-arize.mdx | “应用程序”→“应用”术语统一 |
| zh/cloud/use-dify/monitor/analysis.mdx | “应用程序”→“应用”术语统一 |
| zh/cloud/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base.mdx | “应用程序”→“应用”术语统一（含需修正错字） |
| zh/cloud/use-dify/getting-started/introduction.mdx | Web 应用术语统一 |
| zh/cloud/use-dify/build/text-generator.mdx | Web 应用术语统一 |
| zh/cloud/use-dify/build/additional-features.mdx | Web 应用 caption 统一 |
| zh/cli/quick-start.mdx | 增加 self-host 登录前置变量提示 |
| zh/cli/authenticate.mdx | 增加 self-host 登录前置变量提示 |
| ja/self-host/use-dify/workspace/readme.mdx | 联系销售链接更新 |
| ja/self-host/use-dify/workspace/plugins.mdx | 联系销售链接更新 |
| ja/self-host/use-dify/workspace/personal-account-management.mdx | 联系销售链接更新 |
| ja/self-host/use-dify/workspace/app-management.mdx | 图标名修复 |
| ja/self-host/use-dify/publish/webapp/web-app-settings.mdx | 图标修复；联系销售链接更新；術語統一 |
| ja/self-host/use-dify/publish/webapp/embedding-in-websites.mdx | UI 导航名更新；章节重排；文案统一 |
| ja/self-host/use-dify/nodes/user-input.mdx | Web アプリ表記統一 |
| ja/self-host/use-dify/nodes/trigger/webhook-trigger.mdx | インテグレーショントリガー表記に統一 |
| ja/self-host/use-dify/nodes/trigger/plugin-trigger.mdx | タイトル/見出しをインテグレーショントリガーに統一 |
| ja/self-host/use-dify/nodes/trigger/overview.mdx | インテグレーショントリガー表記に統一 |
| ja/self-host/use-dify/nodes/start.mdx | インテグレーショントリガー表記に統一 |
| ja/self-host/use-dify/nodes/human-input.mdx | Web アプリ表記統一 |
| ja/self-host/use-dify/nodes/agent.mdx | 最大反復回数（UI ラベル）に合わせる |
| ja/self-host/use-dify/getting-started/introduction.mdx | Web アプリ表記統一 |
| ja/self-host/use-dify/build/text-generator.mdx | Web アプリ表記統一 |
| ja/self-host/use-dify/build/additional-features.mdx | Web アプリ caption 統一 |
| ja/self-host/deploy/troubleshooting/docker-issues.mdx | Web アプリ表記統一 |
| ja/self-host/deploy/troubleshooting/common-issues.mdx | Web アプリ表記統一 |
| ja/self-host/deploy/overview.mdx | 联系销售链接更新 |
| ja/self-host/deploy/configuration/environments.mdx | Web アプリ表記統一；トリガー名統一 |
| ja/self-host/deploy/advanced-deployments/start-the-frontend-docker-container.mdx | “Web アプリ”表記のスペース調整 |
| ja/learn/tutorials/workflow-101/lesson-10.mdx | Web アプリ表記統一；一括実行ラベル整合 |
| ja/learn/key-concepts.mdx | Web アプリ表記統一（表内注記） |
| ja/develop-plugin/dev-guides-and-walkthroughs/tool-plugin.mdx | tool 参数 type 取值列表补全说明（ja） |
| ja/develop-plugin/dev-guides-and-walkthroughs/cheatsheet.mdx | Web アプリ表記統一 |
| ja/cloud/use-dify/workspace/app-management.mdx | 图标名修复 |
| ja/cloud/use-dify/publish/webapp/workflow-webapp.mdx | UI ラベル整合（例：一括実行、これに似たもの） |
| ja/cloud/use-dify/publish/webapp/web-app-settings.mdx | 图标修复；術語統一 |
| ja/cloud/use-dify/publish/webapp/web-app-access.mdx | Frontmatter 追加；翻译提示格式统一 |
| ja/cloud/use-dify/publish/webapp/embedding-in-websites.mdx | UI 导航名更新；章节重排；文案统一 |
| ja/cloud/use-dify/nodes/user-input.mdx | Web アプリ表記統一 |
| ja/cloud/use-dify/nodes/trigger/webhook-trigger.mdx | インテグレーショントリガー表記に統一 |
| ja/cloud/use-dify/nodes/trigger/plugin-trigger.mdx | タイトル/見出しをインテグレーショントリガーに統一 |
| ja/cloud/use-dify/nodes/trigger/overview.mdx | インテグレーショントリガー表記に統一 |
| ja/cloud/use-dify/nodes/start.mdx | インテグレーショントリガー表記に統一 |
| ja/cloud/use-dify/nodes/human-input.mdx | Web アプリ表記統一 |
| ja/cloud/use-dify/nodes/agent.mdx | 最大反復回数（UI ラベル）に合わせる |
| ja/cloud/use-dify/getting-started/introduction.mdx | Web アプリ表記統一 |
| ja/cloud/use-dify/build/text-generator.mdx | Web アプリ表記統一 |
| ja/cloud/use-dify/build/additional-features.mdx | Web アプリ caption 統一 |
| ja/cli/quick-start.mdx | self-host 登录前置变量提示（ja） |
| ja/cli/authenticate.mdx | self-host 登录前置变量提示（ja） |
| en/self-host/use-dify/workspace/team-members-management.mdx | 联系销售链接更新 |
| en/self-host/use-dify/workspace/readme.mdx | 联系销售链接更新 |
| en/self-host/use-dify/workspace/plugins.mdx | 联系销售链接更新 |
| en/self-host/use-dify/workspace/personal-account-management.mdx | 联系销售链接更新 |
| en/self-host/use-dify/workspace/app-management.mdx | FontAwesome icon 修复 |
| en/self-host/use-dify/publish/webapp/workflow-webapp.mdx | 列表格式与 UI label（More like this/Run Batch）对齐 |
| en/self-host/use-dify/publish/webapp/web-app-settings.mdx | 图标修复；联系销售链接更新；“app”术语统一 |
| en/self-host/use-dify/publish/webapp/embedding-in-websites.mdx | “Embed Into Site”导航名更新；章节重排 |
| en/self-host/use-dify/nodes/user-input.mdx | “WebApp”→“web app”术语统一 |
| en/self-host/use-dify/nodes/human-input.mdx | “WebApp”→“web app”术语统一 |
| en/self-host/use-dify/nodes/agent.mdx | UI label：Maximum Iterations→Max Iterations |
| en/self-host/use-dify/build/additional-features.mdx | “Web App” caption 统一 |
| en/self-host/deploy/troubleshooting/docker-issues.mdx | “WebApp”→“Web app”术语统一 |
| en/self-host/deploy/troubleshooting/common-issues.mdx | “WebApp”→“Web app”术语统一 |
| en/self-host/deploy/overview.mdx | 联系销售链接更新 |
| en/self-host/deploy/configuration/environments.mdx | “WebApp”→“web app”术语统一 |
| en/quick-start.mdx | “AI Credits”→“AI credits”文案统一 |
| en/learn/tutorials/workflow-101/lesson-10.mdx | “WebApp”→“web app”；Run Batch 标签对齐 |
| en/learn/key-concepts.mdx | “WebApp”→“web app”术语统一 |
| en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin.mdx | tool 参数 type 取值列表补全说明 |
| en/develop-plugin/dev-guides-and-walkthroughs/cheatsheet.mdx | “WebApp”→“web apps”术语统一 |
| en/cloud/use-dify/workspace/model-providers.mdx | “AI Credits”→“AI credits”文案统一 |
| en/cloud/use-dify/workspace/app-management.mdx | FontAwesome icon 修复 |
| en/cloud/use-dify/publish/webapp/workflow-webapp.mdx | 列表格式与 UI label 对齐 |
| en/cloud/use-dify/publish/webapp/web-app-settings.mdx | 图标修复；“app”术语统一 |
| en/cloud/use-dify/publish/webapp/web-app-access.mdx | Frontmatter description 补充；UI 路径对齐；标点统一 |
| en/cloud/use-dify/publish/webapp/embedding-in-websites.mdx | “Embed Into Site”导航名更新；章节重排 |
| en/cloud/use-dify/nodes/user-input.mdx | “WebApp”→“web app”术语统一 |
| en/cloud/use-dify/nodes/human-input.mdx | “WebApp”→“web app”术语统一 |
| en/cloud/use-dify/nodes/agent.mdx | UI label：Maximum Iterations→Max Iterations |
| en/cloud/use-dify/build/additional-features.mdx | “Web App” caption 统一 |
| en/cli/quick-start.mdx | 增加 self-host 登录前置变量提示 |
| en/cli/authenticate.mdx | 增加 self-host 登录前置变量提示 |
| en/cloud/use-dify/nodes/trigger/plugin-trigger.mdx | “trigger plugins”→“trigger integrations”措辞对齐 |
Review details
- Files reviewed: 137/143 changed files
- Comments generated: 2
- Review effort level: Low
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
| > 本文档由 AI 自动翻译。如有任何不准确之处，请参考 [英文原版](/en/self-host/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base)。 | ||
|
|
||
| 创建知识库后，你可以继续对其进行管理和优化，以确保它能为你的应用程序提供准确的的上下文信息。通过以下方式，你可以对知识库文件的进行更新、进行召回测试、修改流水线和修改知识库的属性等： | ||
| 创建知识库后，你可以继续对其进行管理和优化，以确保它能为你的应用提供准确的的上下文信息。通过以下方式，你可以对知识库文件的进行更新、进行召回测试、修改流水线和修改知识库的属性等： |
| > 本文档由 AI 自动翻译。如有任何不准确之处，请参考 [英文原版](/en/cloud/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base)。 | ||
|
|
||
| 创建知识库后，你可以继续对其进行管理和优化，以确保它能为你的应用程序提供准确的的上下文信息。通过以下方式，你可以对知识库文件的进行更新、进行召回测试、修改流水线和修改知识库的属性等： | ||
| 创建知识库后，你可以继续对其进行管理和优化，以确保它能为你的应用提供准确的的上下文信息。通过以下方式，你可以对知识库文件的进行更新、进行召回测试、修改流水线和修改知识库的属性等： |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
maintorelease/1.16.1: