Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Refactor security logs as reference (Diátaxis) #9985

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,6 @@ and some of the core features of Read the Docs.
/integrations
/versions
/hosting
/security-log

/builds
/build-customization
Expand Down
1 change: 1 addition & 0 deletions docs/user/reference/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ Features
/server-side-search/index
/user-defined-redirects
/badges
/security-log
40 changes: 17 additions & 23 deletions docs/user/security-log.rst
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -10,49 +10,43 @@ 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 logins have occurred on your user account.
benjaoming marked this conversation as resolved.
Show resolved Hide resolved

The security log tracks the following events:

- Authentication on the dashboard
- Authentication on documentation pages (:doc:`/commercial/index` only)
benjaoming marked this conversation as resolved.
Show resolved Hide resolved

Authentication failures and successes are both tracked.

To access your logs:

- Click on :guilabel:`<Username dropdown>`
- Click on :guilabel:`Settings`
- Click on :guilabel:`Security Log`

This log is useful to validate that no unauthorized logins have occured on your user account.
Logs are available in :menuselection:`<Username dropdown> --> 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 <https://readthedocs.com/pricing/>`__ for more details.
benjaoming marked this conversation as resolved.
Show resolved Hide resolved
We track the following events:
Your organization security log is a great place to check periodically to ensure there hasn't been unauthorized access to your organization.

Organization logs track the following events:

- Authentication on documentation pages from your organization
- User access to every documentation page from your organization (**Enterprise plans only**)
benjaoming marked this conversation as resolved.
Show resolved Hide resolved

Authentication failures and successes are both tracked.

To access your organization logs:

- Click on :guilabel:`<Username dropdown>`
- Click on :guilabel:`Organizations`
- Click on :guilabel:`<Organization name>`
- Click on :guilabel:`Settings`
- Click on :guilabel:`Security Log`

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:`<Username dropdown> --> Organizations --> <Organization name> --> 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`.
Expand Down