Skip to content

Commit 5687df3

Browse files
emmavioletvgrlethanpalm
authored
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>
1 parent b211776 commit 5687df3

File tree

9 files changed

+45
-11
lines changed

9 files changed

+45
-11
lines changed
Loading
Loading

content/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ redirect_from:
66
- /enterprise/admin/articles/determining-whether-a-user-account-is-dormant/
77
- /enterprise/admin/user-management/managing-dormant-users
88
- /admin/user-management/managing-dormant-users
9-
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 %}'
1010
versions:
11+
ghec: '*'
1112
ghes: '*'
1213
ghae: '*'
1314
type: how_to
@@ -16,16 +17,12 @@ topics:
1617
- Enterprise
1718
- Licensing
1819
---
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 %}
2521

22+
{% ifversion ghes or ghae%}
2623
## Viewing dormant users
2724

28-
You can view a list of all dormant users who have not been suspended and who are not site administrators.
25+
{% data reusables.enterprise-accounts.viewing-dormant-users %}
2926

3027
{% data reusables.enterprise_site_admin_settings.access-settings %}
3128
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
4744
{% data reusables.enterprise_site_admin_settings.dormancy-threshold %}
4845

4946
{% data reusables.enterprise-accounts.access-enterprise %}
50-
{% ifversion ghes or ghae %}
5147
{% data reusables.enterprise-accounts.policies-tab %}
52-
{% else %}
5348
{% data reusables.enterprise-accounts.settings-tab %}
54-
{% endif %}
5549
{% data reusables.enterprise-accounts.options-tab %}
5650
4. Under "Dormancy threshold", use the drop-down menu, and click the desired dormancy threshold.
5751
![The Dormancy threshold drop-down menu](/assets/images/enterprise/site-admin-settings/dormancy-threshold-menu.png)
52+
53+
{% endif %}
54+
55+
{% ifversion ghec %}
56+
57+
{% 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+
![Download button under "Other" on the Compliance page](/assets/images/help/business-accounts/dormant-users-download-button.png)
71+
72+
{% endif %}

content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ You can view {% ifversion ghec %}all the {% data variables.product.prodname_ghe_
3838
{% ifversion ghec %}1. Optionally, to view a list of pending invitations, click **_NUMBER_ pending**.
3939
!["NUMBER pending" button to the right of search and filter options](/assets/images/help/enterprises/members-pending.png){% endif %}
4040

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+
4145
## Further reading
4246

4347
- "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)"
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
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 %}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
"Activity" includes, but is not limited to:
2+
- Signing in to {% data variables.product.product_name %}.
3+
- Commenting on issues and pull requests.
4+
- Creating, deleting, watching, and starring repositories.
5+
- Pushing commits.
6+
- Accessing resources by using a personal access token or SSH key.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{% note %}
2+
3+
**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.
4+
5+
{% endnote %}
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
1. In the enterprise account sidebar, click {% octicon "checklist" aria-label="The Compliance icon" %} **Compliance**.
2+
![Compliance tab in the enterprise account sidebar](/assets/images/help/business-accounts/enterprise-accounts-compliance-tab.png)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
You can view a list of all dormant users who have not been suspended and who are not site administrators.

0 commit comments

Comments
 (0)