summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/development/doc_styleguide.md24
1 files changed, 16 insertions, 8 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index dc7d832ce3a..4fe69e63d4f 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -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