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
Léo-Paul Géneau
gitlab-ce
Commits
0ba0dc1d
Commit
0ba0dc1d
authored
Dec 28, 2018
by
Mike Lewis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Allow contributors to rename files per process
parent
b75d6402
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
6 deletions
+8
-6
doc/development/documentation/index.md
doc/development/documentation/index.md
+8
-6
No files found.
doc/development/documentation/index.md
View file @
0ba0dc1d
...
...
@@ -153,13 +153,14 @@ help or direct you to the right one.
### Changing document location
Changing a document's location is not to be taken lightly. Remember that the
documentation is available to all installations under
`help/`
and not only to
GitLab.com or
<http://docs.gitlab.com>
. Make sure this is discussed with the
Documentation team beforehand.
Changing a document's location requires specific steps to be followed to ensure that
users can seamlessly access the new doc page, whether they are accesing content
on a GitLab instance domain at
`/help`
or at docs.gitlab.com. Be sure to ping a
GitLab technical writer if you have any questions during the process, and at the
very least, after this change is merged, so that it can be reviewed promptly.
If you indeed need to change a document's location, do
NOT
remove the old
document, but rather replace all of its content
s
with a new line:
If you indeed need to change a document's location, do
not
remove the old
document, but rather replace all of its content with a new line:
```
md
This document was moved to
[
another location
](
path/to/new_doc.md
)
.
...
...
@@ -197,6 +198,7 @@ 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/`
).
You must search these paths for references to the doc and update them as well.
-
The above
`git grep`
command will search recursively in the directory you run
it in for
`workflow/lfs/lfs_administration`
and
`lfs/lfs_administration`
and will print the file and the line where this file is mentioned.
...
...
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