Skip to content
GitLab
菜单
为什么选择 GitLab
定价
联系销售
探索
为什么选择 GitLab
定价
联系销售
探索
登录
获取免费试用
主导航
搜索或转到…
项目
GitLab
管理
动态
成员
标记
计划
议题
议题看板
里程碑
迭代
需求
代码
合并请求
仓库
分支
提交
标签
仓库图
比较修订版本
代码片段
锁定的文件
构建
流水线
作业
流水线计划
测试用例
产物
部署
发布
Package registry
Container registry
模型注册表
运维
环境
Terraform 模块
监控
事件
服务台
分析
价值流分析
贡献者分析
CI/CD 分析
仓库分析
代码评审分析
议题分析
洞察
模型实验
效能分析
帮助
帮助
支持
GitLab 文档
比较 GitLab 各版本
社区论坛
为极狐GitLab 提交贡献
提交反馈
隐私声明
快捷键
?
新增功能
4
代码片段
群组
项目
显示更多面包屑
gitlab-cn
GitLab
提交
e92fdefd
提交
e92fdefd
编辑于
3 years ago
作者:
Fiona Neill
浏览文件
操作
下载
差异文件
Merge branch 'sselhorn-master-patch-42261' into 'master'
Updated above for version numbers See merge request gitlab-org/gitlab!71748
上级
6df7d53e
f344cbf0
No related branches found
No related tags found
无相关合并请求
变更
1
隐藏空白变更内容
行内
左右并排
显示
1 个更改的文件
doc/development/documentation/styleguide/word_list.md
+24
-16
24 个添加, 16 个删除
doc/development/documentation/styleguide/word_list.md
有
24 个添加
和
16 个删除
doc/development/documentation/styleguide/word_list.md
+
24
−
16
浏览文件 @
e92fdefd
...
@@ -29,6 +29,12 @@ Try to avoid using **above** when referring to an example or table in a document
...
@@ -29,6 +29,12 @@ Try to avoid using **above** when referring to an example or table in a document
-
In the previous example, the dog had fleas.
-
In the previous example, the dog had fleas.
Do not use
**above**
when referring to versions of the product. Use
[
**later**
](
#later
)
instead.
-
Do: In GitLab 14.4 and later...
-
Do not: In GitLab 14.4 and above...
-
Do not: In GitLab 14.4 and higher...
## admin, admin area
## admin, admin area
Use
**administration**
,
**administrator**
,
**administer**
, or
**Admin Area**
instead. (
[
Vale
](
../testing.md#vale
)
rule:
[
`Admin.yml`
](
https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/Admin.yml
)
)
Use
**administration**
,
**administrator**
,
**administer**
, or
**Admin Area**
instead. (
[
Vale
](
../testing.md#vale
)
rule:
[
`Admin.yml`
](
https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/Admin.yml
)
)
...
@@ -150,8 +156,8 @@ When writing about the Developer role:
...
@@ -150,8 +156,8 @@ When writing about the Developer role:
-
Do not use the phrase,
**if you are a developer**
to mean someone who is assigned the Developer
-
Do not use the phrase,
**if you are a developer**
to mean someone who is assigned the Developer
role. Instead, write it out. For example,
**if you are assigned the Developer role**
.
role. Instead, write it out. For example,
**if you are assigned the Developer role**
.
-
To describe a situation where the Developer role is the minimum required:
-
To describe a situation where the Developer role is the minimum required:
-
Avoid:
the Developer role
or higher
-
Do: at least
the Developer role
-
Use instead: at least
the Developer role
-
Do not:
the Developer role
or higher
Do not use
**Developer permissions**
. A user who is assigned the Developer role has a set of associated permissions.
Do not use
**Developer permissions**
. A user who is assigned the Developer role has a set of associated permissions.
...
@@ -220,8 +226,8 @@ Use **expand** instead of **open** when you are talking about expanding or colla
...
@@ -220,8 +226,8 @@ Use **expand** instead of **open** when you are talking about expanding or colla
Use
**box**
instead of
**field**
or
**text box**
.
Use
**box**
instead of
**field**
or
**text box**
.
-
Avoid
: In the
**Variable name**
field
, enter
`my text`
.
-
Do
: In the
**Variable name**
box
, enter
`my text`
.
-
Use instead
: In the
**Variable name**
box
, enter
`my text`
.
-
Do not
: In the
**Variable name**
field
, enter
`my text`
.
## foo
## foo
...
@@ -265,8 +271,8 @@ When writing about the Guest role:
...
@@ -265,8 +271,8 @@ When writing about the Guest role:
-
Do not use the phrase,
**if you are a guest**
to mean someone who is assigned the Guest
-
Do not use the phrase,
**if you are a guest**
to mean someone who is assigned the Guest
role. Instead, write it out. For example,
**if you are assigned the Guest role**
.
role. Instead, write it out. For example,
**if you are assigned the Guest role**
.
-
To describe a situation where the Guest role is the minimum required:
-
To describe a situation where the Guest role is the minimum required:
-
Avoid:
the Guest role
or higher
-
Do: at least
the Guest role
-
Use instead: at least
the Guest role
-
Do not:
the Guest role
or higher
Do not use
**Guest permissions**
. A user who is assigned the Guest role has a set of associated permissions.
Do not use
**Guest permissions**
. A user who is assigned the Guest role has a set of associated permissions.
...
@@ -282,15 +288,16 @@ Do not use **high availability** or **HA**. Instead, direct readers to the GitLa
...
@@ -282,15 +288,16 @@ Do not use **high availability** or **HA**. Instead, direct readers to the GitLa
Do not use
**higher**
when talking about version numbers.
Do not use
**higher**
when talking about version numbers.
-
Do: In GitLab 14.1 and later.
-
Do: In GitLab 14.4 and later...
-
Do not: In GitLab 14.1 and higher.
-
Do not: In GitLab 14.4 and higher...
-
Do not: In GitLab 14.4 and above...
## hit
## hit
Don't use
**hit**
to mean
**press**
.
Don't use
**hit**
to mean
**press**
.
-
Avoid: Hit the
**ENTER**
button
.
-
Do: Press
**ENTER**
.
-
Use instead: Press
**ENTER**
.
-
Do not: Hit the
**ENTER**
button
.
## I
## I
...
@@ -326,8 +333,9 @@ If you want to use **CI** with the word **job**, use **CI/CD job** rather than *
...
@@ -326,8 +333,9 @@ If you want to use **CI** with the word **job**, use **CI/CD job** rather than *
Use
**later**
when talking about version numbers.
Use
**later**
when talking about version numbers.
-
Avoid: In GitLab 14.1 and higher.
-
Do: In GitLab 14.1 and later...
-
Use instead: In GitLab 14.1 and later.
-
Do not: In GitLab 14.1 and higher...
-
Do not: In GitLab 14.1 and above...
## list
## list
...
@@ -354,8 +362,8 @@ When writing about the Maintainer role:
...
@@ -354,8 +362,8 @@ When writing about the Maintainer role:
-
Do not use the phrase,
**if you are a maintainer**
to mean someone who is assigned the Maintainer
-
Do not use the phrase,
**if you are a maintainer**
to mean someone who is assigned the Maintainer
role. Instead, write it out. For example,
**if you are assigned the Maintainer role**
.
role. Instead, write it out. For example,
**if you are assigned the Maintainer role**
.
-
To describe a situation where the Maintainer role is the minimum required:
-
To describe a situation where the Maintainer role is the minimum required:
-
Avoid:
the Maintainer role
or higher
-
Do: at least
the Maintainer role
-
Use instead: at least
the Maintainer role
-
Do not:
the Maintainer role
or higher
Do not use
**Maintainer permissions**
. A user who is assigned the Maintainer role has a set of associated permissions.
Do not use
**Maintainer permissions**
. A user who is assigned the Maintainer role has a set of associated permissions.
...
@@ -461,8 +469,8 @@ When writing about the Reporter role:
...
@@ -461,8 +469,8 @@ When writing about the Reporter role:
-
Do not use the phrase,
**if you are a reporter**
to mean someone who is assigned the Reporter
-
Do not use the phrase,
**if you are a reporter**
to mean someone who is assigned the Reporter
role. Instead, write it out. For example,
**if you are assigned the Reporter role**
.
role. Instead, write it out. For example,
**if you are assigned the Reporter role**
.
-
To describe a situation where the Reporter role is the minimum required:
-
To describe a situation where the Reporter role is the minimum required:
-
Avoid:
the Reporter role
or higher
-
Do: at least
the Reporter role
-
Use instead: at least
the Reporter role
-
Do not:
the Reporter role
or higher
Do not use
**Reporter permissions**
. A user who is assigned the Reporter role has a set of associated permissions.
Do not use
**Reporter permissions**
. A user who is assigned the Reporter role has a set of associated permissions.
...
...
此差异已折叠。
点击以展开。
预览
0%
加载中
请重试
或
添加新附件
.
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
保存评论
取消
想要评论请
注册
或
登录