kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Allow contributors to rename files per process

This commit is contained in:
Mike Lewis 2018-12-28 22:18:32 +00:00
parent b75d640282
commit 0ba0dc1daf
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/development/documentation/index.md
View File

@ -153,13 +153,14 @@ help or direct you to the right one.
### Changing document location ### Changing document location
Changing a document's location is not to be taken lightly. Remember that the Changing a document's location requires specific steps to be followed to ensure that
documentation is available to all installations under `help/` and not only to users can seamlessly access the new doc page, whether they are accesing content
GitLab.com or <http://docs.gitlab.com>. Make sure this is discussed with the on a GitLab instance domain at `/help` or at docs.gitlab.com. Be sure to ping a
Documentation team beforehand. 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 If you indeed need to change a document's location, do not remove the old
document, but rather replace all of its contents with a new line: document, but rather replace all of its content with a new line:
```md ```md
This document was moved to [another location](path/to/new_doc.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, - 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 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/`). 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 - The above `git grep` command will search recursively in the directory you run
it in for `workflow/lfs/lfs_administration` and `lfs/lfs_administration` it in for `workflow/lfs/lfs_administration` and `lfs/lfs_administration`
and will print the file and the line where this file is mentioned. and will print the file and the line where this file is mentioned.