Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
李少辉-开发者
gitlab-foss
提交
80447975
G
gitlab-foss
项目概览
李少辉-开发者
/
gitlab-foss
通知
15
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
G
gitlab-foss
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
提交
80447975
编写于
8月 27, 2016
作者:
A
Achilleas Pipinellis
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Clarify steps when changing a document's location
[ci skip]
上级
f8857c63
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
16 addition
and
8 deletion
+16
-8
doc/development/doc_styleguide.md
doc/development/doc_styleguide.md
+16
-8
未找到文件。
doc/development/doc_styleguide.md
浏览文件 @
80447975
...
...
@@ -222,18 +222,26 @@ For example, if you were to move `doc/workflow/lfs/lfs_administration.md` to
```
1.
Find and replace any occurrences of the old location with the new one.
A quick way to find them is to use
`grep`
:
A quick way to find them is to use
`grep`
. First go to the root directory
where you cloned the
`gitlab-ce`
repository and then do:
```
grep -nR "lfs_administration.md" doc/
grep -nR "workflow/lfs/lfs_administration" app/ doc/ spec/
grep -nR "lfs/lfs_administration" app/ doc/ spec/
```
The above command will search in the `doc/` directory for
`lfs_administration.md` recursively and will print the file and the line
where this file is mentioned. Note that we used just the filename
(`lfs_administration.md`) and not the whole the relative path
(`workflow/lfs/lfs_administration.md`).
Things to note:
-
Since we also use inline documentation, except for the documentation itself,
the document might also be referenced in the views of GitLab (
`app/`
) which will
render when visiting
`/help`
, and sometimes in the testing suite (
`spec/`
).
-
The above
`grep`
command will search in the
`app/`
,
`doc/`
and
`spec/`
directories for
`workflow/lfs/lfs_administration`
and
`lfs/lfs_administration`
recursively and will print the file and the line where this file is mentioned.
You may ask why the two greps. Since we use relative paths to link to
documentation, sometimes it might be useful to search a path deeper.
-
The
`*.md`
extension is not used when a document is linked to GitLab's
built-in help page, that's why we omit it in
`grep`
.
## Configuration documentation for source and Omnibus installations
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录