diff --git a/docs/user/index.rst b/docs/user/index.rst index 7e79942b038..5a244f4fcee 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -157,7 +157,6 @@ and some of the core features of Read the Docs. /integrations /versions /hosting - /security-log /builds /build-customization diff --git a/docs/user/reference/features.rst b/docs/user/reference/features.rst index 917e10182d2..23b555f46c0 100644 --- a/docs/user/reference/features.rst +++ b/docs/user/reference/features.rst @@ -18,3 +18,4 @@ Features /server-side-search/index /user-defined-redirects /badges + /security-log diff --git a/docs/user/security-log.rst b/docs/user/security-log.rst index 02d2f873d27..f3834ccf212 100644 --- a/docs/user/security-log.rst +++ b/docs/user/security-log.rst @@ -1,5 +1,5 @@ -Security log and auditing -========================= +Security logs +============= Security logs allow you to audit what has happened recently in your organization or account. This feature is quite important for many security compliance programs, @@ -10,49 +10,46 @@ so that you can confirm this access was from the intended person. Security logs are only visible to organization owners. You can invite other team members as owners. +.. seealso:: + + :doc:`/legal/security-policy` + General information and reference about how security is handled on Read the Docs. + User security log ----------------- -We store user security logs for the last 90 days, and track the following events: +We store a user security log for the latest 90 days of activity. +This log is useful to validate that no unauthorized events have occurred. -- Authentication on the dashboard -- Authentication on documentation pages (:doc:`/commercial/index` only) +The security log tracks the following events: -Authentication failures and successes are both tracked. - -To access your logs: +- Authentication on the dashboard. +- Authentication on documentation pages (:doc:`/commercial/index` only). +- When invitations to manage a project are sent, accepted, revoked or declined. -- Click on :guilabel:`` -- Click on :guilabel:`Settings` -- Click on :guilabel:`Security Log` +Authentication failures and successes are both tracked. -This log is useful to validate that no unauthorized logins have occured on your user account. +Logs are available in :menuselection:` --> Settings --> Security Log`. Organization security log ------------------------- -.. note:: - - This feature exists only on :doc:`/commercial/index`. +.. include:: /shared/admonition-rtd-business.rst The length of log storage varies with your plan, -check our `pricing page `__ for more details. -We track the following events: - -- Authentication on documentation pages from your organization -- User access to every documentation page from your organization (**Enterprise plans only**) +check our `pricing page `__ for more details. +Your organization security log is a great place to check periodically to ensure there hasn't been unauthorized access to your organization. -Authentication failures and successes are both tracked. +Organization logs track the following events: -To access your organization logs: +- Authentication on documentation pages from your organization. +- User accesses a documentation page from your organization (**Enterprise plans only**). +- User accesses a documentation's downloadable formats (**Enterprise plans only**). +- Invitations to organization teams are sent, revoked or accepted. -- Click on :guilabel:`` -- Click on :guilabel:`Organizations` -- Click on :guilabel:`` -- Click on :guilabel:`Settings` -- Click on :guilabel:`Security Log` +Authentication failures and successes are both tracked. -Your organization security log is a great place to check periodically to ensure there hasn't been unauthorized access to your organization. +Logs are available in :menuselection:` --> Organizations --> --> Settings --> Security Log`. If you have any additional information that you wished the security log was capturing, you can always reach out to :doc:`/support`.