Skip to content

Commit

Permalink
Docs: Refactor security logs as howto (Diátaxis) (#9985)
Browse files Browse the repository at this point in the history
* Adds a seealso and includes existing rtd4b

* Relabel the current article as a how-to

* Refactor as feature reference

* Apply suggestions from @ericholscher's code review

Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>

* Adds @stsewd suggestions - dot some item lists

* Rephrase security log of downloading documentation

---------

Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
  • Loading branch information
benjaoming and ericholscher committed Feb 7, 2023
1 parent a944d57 commit c0ecea4
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 29 deletions.
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 @@ -19,3 +19,4 @@ Features
/automation-rules
/user-defined-redirects
/badges
/security-log
53 changes: 25 additions & 28 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,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:`<Username dropdown>`
- 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:`<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.
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 <https://about.readthedocs.com/pricing/>`__ 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:`<Username dropdown>`
- Click on :guilabel:`Organizations`
- Click on :guilabel:`<Organization name>`
- 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:`<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

0 comments on commit c0ecea4

Please sign in to comment.