diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-01-20 10:44:26 +0100 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-01-20 10:44:26 +0100 |
| commit | 086cbca6bf9d6fdad862a19b7fe468a315b05803 (patch) | |
| tree | 791466750da1f3863112087880b2363263dd18d3 | |
| parent | 9d756f3d8be74103fff0c119e2e1e0701ec93d54 (diff) | |
| download | gitlab-ce-086cbca6bf9d6fdad862a19b7fe468a315b05803.tar.gz | |
Link to restart_gitlab.md and some more fixesdoc_restart_gitlab
[ci skip]
| -rw-r--r-- | doc/development/doc_styleguide.md | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 0539bc2df21..caaa4032db2 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -105,13 +105,19 @@ Inside the document: ## References -- There are many cases that a restart/reconfigure of GitLab is required. To +- **GitLab Restart:** + There are many cases that a restart/reconfigure of GitLab is required. To avoid duplication, link to the special document that can be found in - `doc/administration/restart_gitlab.md`. Usually the text will read like: + [`doc/administration/restart_gitlab.md`][doc-restart]. Usually the text will + read like: ``` - Save the file and [reconfigure GitLab](../administration/restart_gitlab.md) for the changes to take effect. + Save the file and [reconfigure GitLab](../administration/restart_gitlab.md) + for the changes to take effect. ``` + If the document you are editing resides in a place other than the GitLab CE/EE + `doc/` directory, instead of the relative link, use the full path: + `http://doc.gitlab.com/ce/administration/restart_gitlab.html`. Replace `reconfigure` with `restart` where appropriate. ## API @@ -240,3 +246,4 @@ curl -X PUT -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" -d "restricted_signup_domai [cURL]: http://curl.haxx.se/ "cURL website" [single spaces]: http://www.slate.com/articles/technology/technology/2011/01/space_invaders.html [gfm]: http://doc.gitlab.com/ce/markdown/markdown.html#newlines "GitLab flavored markdown documentation" +[doc-restart]: ../administration/restart_gitlab.md "GitLab restart documentation" |