Skip to content

Commit

Permalink
Adds documentation for GHEC user dormancy reporting (#22029)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
3 people authored Nov 2, 2021
1 parent b211776 commit 5687df3
Show file tree
Hide file tree
Showing 9 changed files with 45 additions and 11 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ redirect_from:
- /enterprise/admin/articles/determining-whether-a-user-account-is-dormant/
- /enterprise/admin/user-management/managing-dormant-users
- /admin/user-management/managing-dormant-users
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 %}'
intro: '{% data reusables.enterprise-accounts.dormant-user-activity-threshold %}'
versions:
ghec: '*'
ghes: '*'
ghae: '*'
type: how_to
Expand All @@ -16,16 +17,12 @@ topics:
- Enterprise
- Licensing
---
"Activity" includes, but is not limited to:
- Signing in to {% data variables.product.product_name %}.
- Commenting on issues and pull requests.
- Creating, deleting, watching, and starring repositories.
- Pushing commits.{% ifversion ghes or ghae %}
- Accessing resources by using a personal access token or SSH key.{% endif %}
{% data reusables.enterprise-accounts.dormant-user-activity %}

{% ifversion ghes or ghae%}
## Viewing dormant users

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

{% data reusables.enterprise_site_admin_settings.access-settings %}
3. In the left sidebar, click **Dormant users**.
Expand All @@ -47,11 +44,29 @@ You can view a list of all dormant users who have not been suspended and who are
{% data reusables.enterprise_site_admin_settings.dormancy-threshold %}

{% data reusables.enterprise-accounts.access-enterprise %}
{% ifversion ghes or ghae %}
{% data reusables.enterprise-accounts.policies-tab %}
{% else %}
{% data reusables.enterprise-accounts.settings-tab %}
{% endif %}
{% data reusables.enterprise-accounts.options-tab %}
4. Under "Dormancy threshold", use the drop-down menu, and click the desired dormancy threshold.
![The Dormancy threshold drop-down menu](/assets/images/enterprise/site-admin-settings/dormancy-threshold-menu.png)

{% endif %}

{% ifversion ghec %}

{% data reusables.enterprise-accounts.dormant-user-release-phase %}

{% warning %}

**Note:** During the private beta, ongoing improvements to the report download feature may limit its availability.

{% endwarning %}

## Downloading the dormant users report from your enterprise account

{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.enterprise-accounts-compliance-tab %}
1. To download your Dormant Users (beta) report as a CSV file, under "Other", click {% octicon "download" aria-label="The Download icon" %} **Download**.
![Download button under "Other" on the Compliance page](/assets/images/help/business-accounts/dormant-users-download-button.png)

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ You can view {% ifversion ghec %}all the {% data variables.product.prodname_ghe_
{% ifversion ghec %}1. Optionally, to view a list of pending invitations, click **_NUMBER_ pending**.
!["NUMBER pending" button to the right of search and filter options](/assets/images/help/enterprises/members-pending.png){% endif %}

## Viewing dormant users

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)."

## Further reading

- "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)"
Original file line number Diff line number Diff line change
@@ -0,0 +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 %}
6 changes: 6 additions & 0 deletions data/reusables/enterprise-accounts/dormant-user-activity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
"Activity" includes, but is not limited to:
- Signing in to {% data variables.product.product_name %}.
- Commenting on issues and pull requests.
- Creating, deleting, watching, and starring repositories.
- Pushing commits.
- Accessing resources by using a personal access token or SSH key.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% note %}

**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.

{% endnote %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
1. In the enterprise account sidebar, click {% octicon "checklist" aria-label="The Compliance icon" %} **Compliance**.
![Compliance tab in the enterprise account sidebar](/assets/images/help/business-accounts/enterprise-accounts-compliance-tab.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
You can view a list of all dormant users who have not been suspended and who are not site administrators.

0 comments on commit 5687df3

Please sign in to comment.