From 4b1023105a692b3f36f2a9c51fcf193b411156ed Mon Sep 17 00:00:00 2001 From: Jeroen Nijhof Date: Mon, 11 Jan 2016 17:11:22 +0100 Subject: Add housekeeping feature documentation --- doc/README.md | 1 + doc/administration/housekeeping.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 doc/administration/housekeeping.md diff --git a/doc/README.md b/doc/README.md index 25fe3abcb9a..5a05fbe50d3 100644 --- a/doc/README.md +++ b/doc/README.md @@ -67,6 +67,7 @@ - [Reply by email](incoming_email/README.md) Allow users to comment on issues and merge requests by replying to notification emails. - [Migrate GitLab CI to CE/EE](migrate_ci_to_ce/README.md) Follow this guide to migrate your existing GitLab CI data to GitLab CE/EE. - [Git LFS configuration](workflow/lfs/lfs_administration.md) +- [Housekeeping](administration/housekeeping.md) Keep your git repository tidy and fast. ## Contributor documentation diff --git a/doc/administration/housekeeping.md b/doc/administration/housekeeping.md new file mode 100644 index 00000000000..9c4fb72fd73 --- /dev/null +++ b/doc/administration/housekeeping.md @@ -0,0 +1,13 @@ +# Housekeeping + +## Introduction + +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. + +Users are encouraged to run this task on a regular basis to maintain good disk space utilization and good operating performance. + +## Where can I find it? + +Just go to your project settings page and you will find the housekeeping function below the project settings form. -- cgit v1.2.1 From a42fe49c8c953c0aa8ca20c8fb5a141447128894 Mon Sep 17 00:00:00 2001 From: Jeroen Nijhof Date: Wed, 13 Jan 2016 12:07:05 +0100 Subject: Replaced user recommendation with link to git-gc documentation --- doc/administration/housekeeping.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/administration/housekeeping.md b/doc/administration/housekeeping.md index 9c4fb72fd73..b90f916fea9 100644 --- a/doc/administration/housekeeping.md +++ b/doc/administration/housekeeping.md @@ -6,7 +6,7 @@ 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. -Users are encouraged to run this task on a regular basis to maintain good disk space utilization and good operating performance. +See https://www.kernel.org/pub/software/scm/git/docs/git-gc.html for details. ## Where can I find it? -- cgit v1.2.1 From e08e90edbbd28533f215f0dcf274baefb9fc87fd Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Thu, 21 Jan 2016 23:10:47 +0100 Subject: Refactor housekeeping documentation [ci skip] --- doc/administration/housekeeping.md | 21 +++++++++++++++------ doc/administration/img/housekeeping_settings.png | Bin 0 -> 23856 bytes 2 files changed, 15 insertions(+), 6 deletions(-) create mode 100644 doc/administration/img/housekeeping_settings.png 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 Binary files /dev/null and b/doc/administration/img/housekeeping_settings.png differ -- cgit v1.2.1