summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2018-08-15 14:40:39 +0200
committerAchilleas Pipinellis <axil@gitlab.com>2018-08-15 15:11:39 +0200
commit627c327cb001910433eb26deac22fe4dcbc9679f (patch)
tree64e754e14c4bb8abb83d2968bfe974c1742c22d6 /doc
parent7a2ee08ac6859ba0ca43aceb5816515fc24aca2c (diff)
downloadgitlab-ce-627c327cb001910433eb26deac22fe4dcbc9679f.tar.gz
Copyedit instance statistics docs
Diffstat (limited to 'doc')
-rw-r--r--doc/user/admin_area/monitoring/convdev.md5
-rw-r--r--doc/user/admin_area/settings/usage_statistics.md9
-rw-r--r--doc/user/admin_area/user_cohorts.md5
-rw-r--r--doc/user/index.md4
-rw-r--r--doc/user/instance_statistics/img/cohorts.pngbin177434 -> 59494 bytes
-rw-r--r--doc/user/instance_statistics/img/instance_statistics_button.pngbin9167 -> 9462 bytes
-rw-r--r--doc/user/instance_statistics/img/instance_statistics_visibility_setting.pngbin35024 -> 0 bytes
-rw-r--r--doc/user/instance_statistics/index.md24
-rw-r--r--doc/user/instance_statistics/user_cohorts.md17
9 files changed, 39 insertions, 25 deletions
diff --git a/doc/user/admin_area/monitoring/convdev.md b/doc/user/admin_area/monitoring/convdev.md
new file mode 100644
index 00000000000..6ad8a5a7ff0
--- /dev/null
+++ b/doc/user/admin_area/monitoring/convdev.md
@@ -0,0 +1,5 @@
+---
+redirect_to: '../../instance_statistics/convdev.md'
+---
+
+This document was moved to [another location](../../instance_statistics/convdev.md).
diff --git a/doc/user/admin_area/settings/usage_statistics.md b/doc/user/admin_area/settings/usage_statistics.md
index 381efdf5d67..340f1454e2a 100644
--- a/doc/user/admin_area/settings/usage_statistics.md
+++ b/doc/user/admin_area/settings/usage_statistics.md
@@ -67,6 +67,15 @@ production: &base
usage_ping_enabled: false
```
+## Instance statistics visibility
+
+Once usage ping is enabled, GitLab will gather data from other instances and
+will be able to show [usage statistics](../../instance_statistics/index.md)
+of your instance to your users.
+
+This can be restricted to admins by selecting "Only admins" in the Instance
+Statistics visibility section under **Admin area > Settings > Usage statistics**.
+
[ee-557]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/557
[ee-735]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/735
[ce-23361]: https://gitlab.com/gitlab-org/gitlab-ce/issues/23361
diff --git a/doc/user/admin_area/user_cohorts.md b/doc/user/admin_area/user_cohorts.md
new file mode 100644
index 00000000000..21e61e2ec44
--- /dev/null
+++ b/doc/user/admin_area/user_cohorts.md
@@ -0,0 +1,5 @@
+---
+redirect_to: '../instance_statistics/user_cohorts.md'
+---
+
+This document was moved to [another location](../instance_statistics/user_cohorts.md).
diff --git a/doc/user/index.md b/doc/user/index.md
index 90f0e2285c3..649c0b664a5 100644
--- a/doc/user/index.md
+++ b/doc/user/index.md
@@ -172,3 +172,7 @@ Automate GitLab via [API](../api/README.md).
## Git and GitLab
Learn what is [Git](../topics/git/index.md) and its best practices.
+
+## Instance statistics
+
+See [various statistics](instance_statistics/index.md) of your GitLab instance.
diff --git a/doc/user/instance_statistics/img/cohorts.png b/doc/user/instance_statistics/img/cohorts.png
index 0c19270c257..12e839e7cd2 100644
--- a/doc/user/instance_statistics/img/cohorts.png
+++ b/doc/user/instance_statistics/img/cohorts.png
Binary files differ
diff --git a/doc/user/instance_statistics/img/instance_statistics_button.png b/doc/user/instance_statistics/img/instance_statistics_button.png
index 30355b62fb0..6104321b1a6 100644
--- a/doc/user/instance_statistics/img/instance_statistics_button.png
+++ b/doc/user/instance_statistics/img/instance_statistics_button.png
Binary files differ
diff --git a/doc/user/instance_statistics/img/instance_statistics_visibility_setting.png b/doc/user/instance_statistics/img/instance_statistics_visibility_setting.png
deleted file mode 100644
index 3bb81c5c308..00000000000
--- a/doc/user/instance_statistics/img/instance_statistics_visibility_setting.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/instance_statistics/index.md b/doc/user/instance_statistics/index.md
index b715eccd807..a4eca89b7fe 100644
--- a/doc/user/instance_statistics/index.md
+++ b/doc/user/instance_statistics/index.md
@@ -1,19 +1,19 @@
-# Instance Statistics
+# Instance statistics
-> [Introduced][ce-41416] in GitLab 11.2.
+> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41416)
+in GitLab 11.2.
-Instance Statistics gives users or admins access to instance-wide analysis tools.
-
-This feature is accessible to all users by default, and can be accessed via the top bar.
+Instance statistics gives users or admins access to instance-wide analytics.
+They are accessible to all users by default (GitLab admins can restrict its
+visibility in the [admin area](../admin_area/settings/usage_statistics.md)),
+and can be accessed via the top bar.
![Instance Statistics button](img/instance_statistics_button.png)
-It can be restricted to admins by selecting "Only admins" in the Instance Statistics visibility dropdown in the admin area's Usage statistics area at **Admin area > Settings > Usage statistics**.
-
-![Instance Statistics visibility setting](img/instance_statistics_visibility_setting.png)
+For the statistics to show up, [usage ping must be enabled](../admin_area/settings/usage_statistics.md#usage-ping)
+by an admin in the admin settings area.
-- [Conversational Development (ConvDev) Index](./convdev.md): Provides an overview of your entire instance's feature usage.
-- [User Cohorts](./user_cohorts.md): Display the monthly cohorts of new users and their activities over time.
+There are two kinds of statistics:
-[ce-41416]: https://gitlab.com/gitlab-org/gitlab-ce/issues/41416
-[ping]: ../admin_area/settings/usage_statistics.md#usage-ping
+- [Conversational Development (ConvDev) Index](convdev.md): Provides an overview of your entire instance's feature usage.
+- [User Cohorts](user_cohorts.md): Display the monthly cohorts of new users and their activities over time.
diff --git a/doc/user/instance_statistics/user_cohorts.md b/doc/user/instance_statistics/user_cohorts.md
index 2adc4ab3889..70d5912dc4e 100644
--- a/doc/user/instance_statistics/user_cohorts.md
+++ b/doc/user/instance_statistics/user_cohorts.md
@@ -1,12 +1,10 @@
# Cohorts
-> **Notes:**
-> [Introduced][ce-23361] in GitLab 9.1.
+> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/23361)
+in GitLab 9.1.
As a benefit of having the [usage ping active](../admin_area/settings/usage_statistics.md),
-GitLab lets you analyze the users' activities of your GitLab installation.
-Under `/instance_statistics/cohorts`, when the usage ping is active, GitLab will show the
-monthly cohorts of new users and their activities over time.
+GitLab lets you analyze the users' activities over time of your GitLab installation.
## Overview
@@ -16,7 +14,7 @@ user cohorts.
![User cohort example](img/cohorts.png)
For the cohort of Jan 2018, 15 users have been added on this server and have
-been active since this month. One month later, in Feb 2018, all 15 users are
+been active since this month. One month later, in Feb 2018, all 15 users are
still active. 6 months later (Month 6, July), we can see 10 users from this cohort
are active, or 66% of the original cohort of 15 that joined in January.
@@ -27,10 +25,3 @@ How do we measure the activity of users? GitLab considers a user active if:
* the user signs in
* the user has Git activity (whether push or pull).
-
-## Setup
-
-1. [Activate the usage ping](../admin_area/settings/usage_statistics.md)
-2. Go to `/instance_statistics/cohorts` to see the user cohorts of the server
-
-[ce-23361]: https://gitlab.com/gitlab-org/gitlab-ce/issues/23361