Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Tatuya Kamada
gitlab-ce
Commits
80447975
Commit
80447975
authored
Aug 27, 2016
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clarify steps when changing a document's location
[ci skip]
parent
f8857c63
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
16 additions
and
8 deletions
+16
-8
doc/development/doc_styleguide.md
doc/development/doc_styleguide.md
+16
-8
No files found.
doc/development/doc_styleguide.md
View file @
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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment