From 6a66c829aac72bcc30efa2a2f33550077fb353d6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kamil=20Trzci=C5=84ski?= <ayufan@ayufan.eu>
Date: Thu, 8 Nov 2018 12:18:02 +0100
Subject: [PATCH] Add documentation for archive builds

---
 .../admin/application_settings/_ci_cd.html.haml |  9 ++++-----
 .../settings/continuous_integration.md          | 17 +++++++++++++++++
 2 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/app/views/admin/application_settings/_ci_cd.html.haml b/app/views/admin/application_settings/_ci_cd.html.haml
index adb496495d1..0f0d7acf94d 100644
--- a/app/views/admin/application_settings/_ci_cd.html.haml
+++ b/app/views/admin/application_settings/_ci_cd.html.haml
@@ -42,12 +42,11 @@
         <code>4 mins 2 sec</code>, <code>2h42min</code>.
         = link_to icon('question-circle'), help_page_path('user/admin_area/settings/continuous_integration', anchor: 'default-artifacts-expiration')
     .form-group
-      = f.label :archive_builds_in_human_readable, 'Archive builds in', class: 'label-bold'
+      = f.label :archive_builds_in_human_readable, 'Archive jobs in', class: 'label-bold'
       = f.text_field :archive_builds_in_human_readable, class: 'form-control', placeholder: 'never'
       .form-text.text-muted
-        Set the duration when build gonna be considered old. Archived builds cannot be retried.
-        Make it empty to never expire builds. It has to be larger than 1 day.
-        The default unit is in seconds, but you can define an alternative. For example:
-        <code>4 mins 2 sec</code>, <code>2h42min</code>.
+        Set the duration when job gonna be considered old. Archived jobs cannot be retried.
+        Make it empty to never expire jobs. It has to be no less than 1 day.
+        For example: <code>15 days</code>, <code>1 month</code>, <code>2 years</code>.
 
   = f.submit 'Save changes', class: "btn btn-success"
diff --git a/doc/user/admin_area/settings/continuous_integration.md b/doc/user/admin_area/settings/continuous_integration.md
index 6025a5bbcda..6a003482bb6 100644
--- a/doc/user/admin_area/settings/continuous_integration.md
+++ b/doc/user/admin_area/settings/continuous_integration.md
@@ -49,3 +49,20 @@ and the default value is `30 days`. On GitLab.com they
 This setting is set per job and can be overridden in
 [`.gitlab-ci.yml`](../../../ci/yaml/README.md#artifacts-expire_in).
 To disable the expiration, set it to `0`. The default unit is in seconds.
+
+## Archive jobs in **[CORE ONLY]**
+
+Set this setting to enable when job gonna be considered old.
+The purpose of that feature is to reduce the CI footprint on system
+removing some of the capabilities of the jobs (metadata needed to run the build),
+but persisting the traces and artifacts to retain for auditing purposes.
+
+The archived jobs cannot be retried. Making this field empty does never expire jobs.
+The value has to be no less than 1 day. The example:
+`15 days`, `1 month`, `2 years`.
+
+To change it:
+
+1. Go to **Admin area > Settings > Continuous Integration and Deployment**.
+1. Change the value of archive jobs in.
+1. Hit **Save changes** for the changes to take effect.