You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds documentation for GHEC user dormancy reporting (#22029)
* Adds description of GHEC dormancy reporting
* Remove unneeded if statement
* Only show dormant user section to dotcom users
* Extract common text to a data reusable
* Extract all duplicate content to reusables
* add note, warning, download instructions
* fix versioning
* remove dormancy criteria, add link
Co-authored-by: vgrl <vgrl@github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
intro: 'A user account is considered to be dormant if it has not been active for at least a month.{% ifversion ghes %} You may choose to suspend dormant users to free up user licenses.{% endif %}'
9
+
intro: '{% data reusables.enterprise-accounts.dormant-user-activity-threshold %}'
10
10
versions:
11
+
ghec: '*'
11
12
ghes: '*'
12
13
ghae: '*'
13
14
type: how_to
@@ -16,16 +17,12 @@ topics:
16
17
- Enterprise
17
18
- Licensing
18
19
---
19
-
"Activity" includes, but is not limited to:
20
-
- Signing in to {% data variables.product.product_name %}.
21
-
- Commenting on issues and pull requests.
22
-
- Creating, deleting, watching, and starring repositories.
23
-
- Pushing commits.{% ifversion ghes or ghae %}
24
-
- Accessing resources by using a personal access token or SSH key.{% endif %}
20
+
{% data reusables.enterprise-accounts.dormant-user-activity %}
25
21
22
+
{% ifversion ghes or ghae%}
26
23
## Viewing dormant users
27
24
28
-
You can view a list of all dormantusers who have not been suspended and who are not site administrators.
25
+
{% data reusables.enterprise-accounts.viewing-dormant-users %}
29
26
30
27
{% data reusables.enterprise_site_admin_settings.access-settings %}
31
28
3. In the left sidebar, click **Dormant users**.
@@ -47,11 +44,29 @@ You can view a list of all dormant users who have not been suspended and who are
47
44
{% data reusables.enterprise_site_admin_settings.dormancy-threshold %}
48
45
49
46
{% data reusables.enterprise-accounts.access-enterprise %}
50
-
{% ifversion ghes or ghae %}
51
47
{% data reusables.enterprise-accounts.policies-tab %}
52
-
{% else %}
53
48
{% data reusables.enterprise-accounts.settings-tab %}
54
-
{% endif %}
55
49
{% data reusables.enterprise-accounts.options-tab %}
56
50
4. Under "Dormancy threshold", use the drop-down menu, and click the desired dormancy threshold.
{% data reusables.enterprise-accounts.dormant-user-release-phase %}
58
+
59
+
{% warning %}
60
+
61
+
**Note:** During the private beta, ongoing improvements to the report download feature may limit its availability.
62
+
63
+
{% endwarning %}
64
+
65
+
## Downloading the dormant users report from your enterprise account
66
+
67
+
{% data reusables.enterprise-accounts.access-enterprise %}
68
+
{% data reusables.enterprise-accounts.enterprise-accounts-compliance-tab %}
69
+
1. To download your Dormant Users (beta) report as a CSV file, under "Other", click {% octicon "download" aria-label="The Download icon" %} **Download**.
70
+

Copy file name to clipboardExpand all lines: content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,10 @@ You can view {% ifversion ghec %}all the {% data variables.product.prodname_ghe_
38
38
{% ifversion ghec %}1. Optionally, to view a list of pending invitations, click **_NUMBER_ pending**.
39
39
{% endif %}
40
40
41
+
## Viewing dormant users
42
+
43
+
You can view a list of all dormant users {% ifversion ghes or ghae %} who have not been suspended and {% endif %}who are not site administrators. {% data reusables.enterprise-accounts.dormant-user-activity-threshold %} For more information, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)."
44
+
41
45
## Further reading
42
46
43
47
- "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)"
A user account is considered to be dormant if it has not been active for {% ifversion ghec %}90 days{% else %}at least a month{% endif %}.{% ifversion ghes %} You may choose to suspend dormant users to release user licenses.{% endif %}
**Note:** The Dormant Users report is currently in private beta so admins only have access to this feature with a special invite. To join the private beta, receive support, or address your questions, contact the {% data variables.product.company_short %} representative who helps manage your account.
0 commit comments