summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-01-21 23:10:47 +0100
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-01-21 23:10:47 +0100
commite08e90edbbd28533f215f0dcf274baefb9fc87fd (patch)
treea260a845d58ef433980d6f43a04b273eb49f684c
parent308abc8db05f75da8f1cc66facb5e85bee5c69c4 (diff)
downloadgitlab-ce-e08e90edbbd28533f215f0dcf274baefb9fc87fd.tar.gz
Refactor housekeeping documentation
[ci skip]
-rw-r--r--doc/administration/housekeeping.md21
-rw-r--r--doc/administration/img/housekeeping_settings.pngbin0 -> 23856 bytes
2 files changed, 15 insertions, 6 deletions
diff --git a/doc/administration/housekeeping.md b/doc/administration/housekeeping.md
index b90f916fea9..c27cf1812dc 100644
--- a/doc/administration/housekeeping.md
+++ b/doc/administration/housekeeping.md
@@ -1,13 +1,22 @@
# Housekeeping
-## Introduction
+_**Note:** This feature was [introduced][ce-2371] in GitLab 8.4_
-The housekeeping function runs `git gc` on the current project git repository.
+---
-`git gc` runs a number of housekeeping tasks, such as compressing file revisions (to reduce disk space and increase performance) and removing unreachable objects which may have been created from prior invocations of git add.
+The housekeeping function runs [`git gc`][man] on the current project Git
+repository.
-See https://www.kernel.org/pub/software/scm/git/docs/git-gc.html for details.
+`git gc` runs a number of housekeeping tasks, such as compressing file
+revisions (to reduce disk space and increase performance) and removing
+unreachable objects which may have been created from prior invocations of
+`git add`.
-## Where can I find it?
+You can find this option under your **[Project] > Settings**.
-Just go to your project settings page and you will find the housekeeping function below the project settings form.
+---
+
+![Housekeeping settings](img/housekeeping_settings.png)
+
+[ce-2371]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2371 "Housekeeping merge request"
+[man]: https://www.kernel.org/pub/software/scm/git/docs/git-gc.html "git gc man page"
diff --git a/doc/administration/img/housekeeping_settings.png b/doc/administration/img/housekeeping_settings.png
new file mode 100644
index 00000000000..f7c5bc44367
--- /dev/null
+++ b/doc/administration/img/housekeeping_settings.png
Binary files differ