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
iv
gitlab-ce
Commits
d1abbb3b
Commit
d1abbb3b
authored
Jun 13, 2016
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add guide on changing a document's location
[ci skip]
parent
e8ebc1b6
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
42 additions
and
0 deletions
+42
-0
doc/development/doc_styleguide.md
doc/development/doc_styleguide.md
+42
-0
No files found.
doc/development/doc_styleguide.md
View file @
d1abbb3b
...
...
@@ -141,6 +141,48 @@ Inside the document:
[
ruby-dl
]:
https://www.ruby-lang.org/en/downloads/
"Ruby download website"
## 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.
If you indeed need to change a document's location, do NOT remove the old
document, but rather put a text in it that points to the new location, like:
```
This document was moved to [path/to/new_doc.md](path/to/new_doc.md).
```
where
`path/to/new_doc.md`
is the relative path to the root directory
`doc/`
.
---
For example, if you were to move
`doc/workflow/lfs/lfs_administration.md`
to
`doc/administration/lfs.md`
, then the steps would be:
1.
Copy
`doc/workflow/lfs/lfs_administration.md`
to
`doc/administration/lfs.md`
1.
Replace the contents of
`doc/workflow/lfs/lfs_administration.md`
with:
```
This document was moved to [administration/lfs.md](../../administration/lfs.md).
```
1.
Find and replace any occurrences of the old location with the new one.
A quick way to find them is to use
`grep`
:
```
grep -nR "lfs_administration.md" doc/
```
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`).
## API
Here is a list of must-have items. Use them in the exact order that appears
...
...
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