Skip to content

Commit ed16833

Browse files
authored
Docs: Update security log wording (#9811)
* Update security log wording * Address feedback * Fix linting
1 parent 92e843f commit ed16833

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

docs/user/security-log.rst

+26-10
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
1-
Security Log
2-
============
1+
Security log and auditing
2+
=========================
33

4-
Security logs allow you to see what has happened recently in your organization or account.
5-
We store the IP address and the browser's User-Agent_ on each event,
4+
Security logs allow you to audit what has happened recently in your organization or account.
5+
This feature is quite important for many security compliance programs,
6+
as well as the general peace of mind of knowing what is happening on your account.
7+
We store the IP address and the browser used on each event,
68
so that you can confirm this access was from the intended person.
79

8-
.. _User-Agent: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent
10+
Security logs are only visible to organization owners.
11+
You can invite other team members as owners.
912

1013
User security log
1114
-----------------
1215

13-
We store user security logs from the last 90 days, and track the following events:
16+
We store user security logs for the last 90 days, and track the following events:
1417

1518
- Authentication on the dashboard
1619
- Authentication on documentation pages (:doc:`/commercial/index` only)
@@ -19,18 +22,20 @@ Authentication failures and successes are both tracked.
1922

2023
To access your logs:
2124

22-
- Click on :guilabel:`Username` dropdown
25+
- Click on :guilabel:`<Username dropdown>`
2326
- Click on :guilabel:`Settings`
2427
- Click on :guilabel:`Security Log`
2528

29+
This log is useful to validate that no unauthorized logins have occured on your user account.
30+
2631
Organization security log
2732
-------------------------
2833

2934
.. note::
3035

3136
This feature exists only on :doc:`/commercial/index`.
3237

33-
We store logs according to your plan,
38+
The length of log storage varies with your plan,
3439
check our `pricing page <https://readthedocs.com/pricing/>`__ for more details.
3540
We track the following events:
3641

@@ -41,7 +46,18 @@ Authentication failures and successes are both tracked.
4146

4247
To access your organization logs:
4348

44-
- Click on :guilabel:`Organizations` from your user dropdown
45-
- Click on your organization
49+
- Click on :guilabel:`<Username dropdown>`
50+
- Click on :guilabel:`Organizations`
51+
- Click on :guilabel:`<Organization name>`
4652
- Click on :guilabel:`Settings`
4753
- Click on :guilabel:`Security Log`
54+
55+
Your organization security log is a great place to check periodically to ensure there hasn't been unauthorized access to your organization.
56+
57+
If you have any additional information that you wished the security log was capturing,
58+
you can always reach out to :doc:`/support`.
59+
60+
.. seealso::
61+
62+
:doc:`/security`
63+
Security information related to our own platform, personal data treatment, and how to report a security issue.

0 commit comments

Comments
 (0)