菜单
开源
上次评审:2024 年 6 月 27 日

词汇表

在大多数情况下,您可以参考 Google 开发者文档风格指南中的词汇表 来确定是否应该使用某个词汇。以下指南涵盖以下情况:

  • Grafana 指南与 Google 指南不同。
  • 该词汇未包含在 Google 指南中。
  • 该词汇被广泛使用,无论是在一般场合还是在 Grafana 的其他媒体中。

注意

本页面正在完善中。

A

agentless

请勿使用。Grafana Agent 已被 Grafana Alloy 取代,因此您不应使用基于 agent 的术语。请参考无 Collector

告警规则 (alert rule)

Grafana 告警使用术语 告警规则 (alert rule) 来描述 Grafana 的一项功能,它包括Grafana 管理的告警规则数据源管理的告警规则。更多信息,请参考告警规则

注意

不要将其与Alerting 规则 (alerting rule) 混淆。

Alerting 规则 (alerting rule)

Alerting 规则 (alerting rule) 是在 Grafana Mimir 和 Grafana Loki 中复用的 Prometheus 概念。更多信息请参考Alerting 规则

注意

不要将其与告警规则 (alert rule) 混淆。

B

最佳实践

对于涵盖最佳实践指南的概念性主题,请使用标题 最佳实践

C

CHANGELOG

在命名文件或泛指 CHANGELOG 时,请使用大写字母拼写。在引用特定的 CHANGELOG 文件时,请匹配该文件的大小写。

D

数据源 (data source)

作为名词形式时,请使用此术语而不是 datasource

此外,请使用 data source plugin 而不是 data-source plugin

虽然大多数复合形容词需要连字符,但在这种情况下省略了连字符,以与应用程序中数据源的命名保持一致并减少混淆。

注意

对于其他复合形容词,除非另有说明,否则请使用连字符。

数据集 (dataset)

请使用此术语而不是 data set

对话框 (dialog box)

请使用此术语而不是 modaldialog

此指南特意与 Google 风格指南的建议不同,后者偏好仅使用 dialog,因为 对话框 (dialog box) 是一个用户友好的术语。

请使用此术语而不是 dropdowndrop down

drop-down 用作修饰语,而不是独立名词。例如:下拉菜单 (drop-down menu)

E

容易 (easy)

对您来说简单的事情可能对他人来说并不简单。尝试在句子中去掉这个词,因为通常没有它也可以表达相同的意思。

端到端 (end-to-end)

请使用此术语而不是 e2eE2E

H

悬停在 (hover over)

请使用此术语而不是 hold the pointer overpoint to

K

kebab case

用于指代一种命名约定,其中小写单词之间的空格被短划线替换。

请使用此术语而不是 dash case

M

请使用此术语而不是 hamburger menukebab menu

元监控 (meta-monitoring)

请使用此术语而不是 metamonitoringmeta monitoring

N

无 Collector (no-collector)

用于指代没有 Collector 的部署。请使用此术语而不是 agentless

Node Exporter

在指代产品 Prometheus Node Exporter 时,请将术语 Node Exporter 中的两个词都大写。不要使用 Node exporternode exporter

在指代工具时,请使用 node_exporter。文本应始终格式化为内联代码(用反引号 (`) 包围)。

O

OK, okay

避免在技术文档中使用 OKokay,因为它过于非正式。例外情况是您引用或引述

  • 用户界面
  • HTTP 状态码或其他代码

有关如何格式化这些类型内容的信息,请参考文本格式化指南

Q

快速入门 (quickstart)

无论名词是隐含的还是明确的,都使用不带连字符的复合形容词。例如,您可以使用 快速入门指南 (quickstart guide) 或仅使用 快速入门 (quickstart)。如果您使用名词形式,请写成两个单词。

R

React

请使用此术语而不是 React.jsReactJS

README

在命名文件或泛指 README 时,请使用大写字母拼写。在引用特定的 README 文件时,请匹配该文件的大小写。

S

自行管理 (self-managed)

在谈论 Grafana 部署方法时,请使用 自行管理 (self-managed),而不是 self-hostedon-premon-premise

这与市场部门以及 https://grafana.org.cn 的其他各个部分保持一致。

简单 (simple)

对您来说简单的事情可能对他人来说并不简单。尝试在句子中去掉这个词,因为通常没有它也可以表达相同的意思。

单一视图 (single pane of glass)

该术语仅应用于市场材料中。在技术文档中,请使用以下替代方案:

  • 单一接口
  • 统一接口

SQL (结构化查询语言)

在缩写词 SQL 前使用的冠词 aan 取决于该词的发音。

在指代产品 Microsoft SQL Server 时,SQL 应发音为“sequel”。在这种情况下,请使用冠词 a,例如 a SQL Server analysis

在其他任何上下文(例如 SQL 数据库、错误或服务器)中指代该术语时,SQL 应发音为“ess-cue-el”。在这种情况下,请使用冠词 an,例如 an SQL error

T

时序 (time series)

作为名词形式时,请使用此术语而不是 timeseries

当您需要使用形容词形式时,请使用 time-series 而不是 timeseries