Skip to content

Commit 9c1fdd1

Browse files
Docs: Relabel pages to new top-level "Reference/Policies and legal documents" (Diátaxis) (#9916)
* Diátaxis refactor: Collect legal documents and policies in a single top-level "Reference/Policies and legal documents" * Replace only occurrence of "Policy for Unofficial and Unmaintanied Projects" * Update docs/user/security.rst Co-authored-by: Eric Holscher <[email protected]> * Hide TOC and use nice definition list only, put a placeholder in legal/index (pending that we do a redirect instead), move Account Security to Security Policy. * Add comment about weird legacy locations * Remove legal/index.rst again and replace with Exact Redirect --------- Co-authored-by: Eric Holscher <[email protected]>
1 parent 24d1d97 commit 9c1fdd1

8 files changed

+75
-56
lines changed

docs/user/abandoned-projects.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Policy for Abandoned Projects
2-
=============================
1+
Abandoned projects policy
2+
=========================
33

44
This policy describes the process by which a Read the Docs project :term:`slug` may be changed.
55

docs/user/index.rst

+1-6
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ to help you create fantastic documentation for your project.
111111
/server-side-search/api
112112
/reference/features
113113
/server-side-search/syntax
114+
/reference/policies
114115

115116

116117
Read the Docs feature overview
@@ -304,10 +305,6 @@ of Read the Docs and the larger software documentation ecosystem.
304305
:hidden:
305306
:caption: About Read the Docs
306307

307-
security
308-
dmca/index
309-
abandoned-projects
310-
unofficial-projects
311308
changelog
312309

313310
about
@@ -318,7 +315,5 @@ of Read the Docs and the larger software documentation ecosystem.
318315
advertising/index
319316
sponsors
320317

321-
legal/index
322-
323318
Developer Documentation <https://dev.readthedocs.io>
324319
glossary

docs/user/legal/index.rst

-28
This file was deleted.

docs/user/legal/security-policy.rst

+15-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Security Policy
1+
Security policy
22
===============
33

44
Read the Docs adheres to the following security policies and procedures with
@@ -73,3 +73,17 @@ Continuous integration
7373
Incident response
7474
Our engineering team is on a rotating on-call schedule to respond to
7575
security or availability incidents.
76+
77+
Account security
78+
----------------
79+
80+
* All traffic is encrypted in transit so your login is protected.
81+
* Read the Docs stores only one-way hashes of all passwords.
82+
Nobody at Read the Docs has access to your passwords.
83+
* Account login is protected from brute force attacks with rate limiting.
84+
* While most projects and docs on Read the Docs are public,
85+
we treat your private repositories and private documentation as confidential
86+
and Read the Docs employees may only view them
87+
with your explicit permission in response to your support requests,
88+
or when required for security purposes.
89+
* You can read more about account privacy in our :doc:`/privacy-policy`.

docs/user/privacy-policy.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. This is linked from the footer of readthedocs.org
22
.. and from the version (flyout) menu on docs sites
33
4-
Privacy Policy
4+
Privacy policy
55
==============
66

77
Effective date: **September 30, 2019**

docs/user/reference/policies.rst

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
============================
2+
Policies and legal documents
3+
============================
4+
5+
Here is some of the fine print used by |org_brand| and |com_brand|:
6+
7+
.. File locations are a bit odd here because of legacy.
8+
.. We will move files to new locations and create redirects in a later refactor
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
:hidden:
13+
14+
/abandoned-projects
15+
/unofficial-projects
16+
/privacy-policy
17+
/legal/security-policy
18+
/security
19+
/terms-of-service
20+
DMCA takedown policy </dmca/index>
21+
/legal/dpa/index
22+
23+
:doc:`/abandoned-projects`
24+
Our policy of taking action on abandoned projects.
25+
26+
:doc:`/unofficial-projects`
27+
Our policy of taking action on unofficial and unmaintained projects.
28+
29+
:doc:`/terms-of-service`
30+
The terms of service for using |org_brand| and |com_brand|. You may instead
31+
have a master services agreement for your subscription if you have a custom
32+
or enterprise contract.
33+
34+
:doc:`/privacy-policy`
35+
Our policy on collecting, storing, and protecting user and visitor data.
36+
37+
:doc:`/legal/security-policy`
38+
Our policies around application and infrastructure security.
39+
40+
:doc:`/security`
41+
How we respond to security incidents and how you report a security issue.
42+
43+
:doc:`/legal/dpa/index`
44+
For GDPR and CCPA compliance, we provide a data processing addendum for
45+
|com_brand| customers.
46+
47+
:doc:`/dmca/index`
48+
Our process for taking down content based on DMCA requests and how to submit requests.

docs/user/security.rst

+5-15
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
.. https://readthedocs.org/.well-known/security.txt
33
.. https://readthedocs.org/security/
44
5-
Security
6-
========
5+
Security reports
6+
================
77

88
Security is very important to us at Read the Docs.
99
We follow generally accepted industry standards to protect the personal information
@@ -16,20 +16,10 @@ we are committed to responsible reporting and disclosure of security issues.
1616
:backlinks: none
1717
:depth: 1
1818

19+
.. seealso::
1920

20-
Account security
21-
----------------
22-
23-
* All traffic is encrypted in transit so your login is protected.
24-
* Read the Docs stores only one-way hashes of all passwords.
25-
Nobody at Read the Docs has access to your passwords.
26-
* Account login is protected from brute force attacks with rate limiting.
27-
* While most projects and docs on Read the Docs are public,
28-
we treat your private repositories and private documentation as confidential
29-
and Read the Docs employees may only view them
30-
with your explicit permission in response to your support requests,
31-
or when required for security purposes.
32-
* You can read more about account privacy in our :doc:`privacy-policy`.
21+
:doc:`/legal/security-policy`
22+
Read our policy for security, which we base our security handling and reporting on.
3323

3424
Supported versions
3525
------------------

docs/user/unofficial-projects.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Policy for Unofficial and Unmaintained Projects
2-
===============================================
1+
Unofficial and unmaintained projects policy
2+
===========================================
33

44
This policy describes a process where we take actions against unmaintained_ and unofficial_ forks of project documentation.
55

@@ -84,7 +84,7 @@ Projects that are determined to be unmaintained_ and unofficial_ will have a ``r
8484
8585
# robots.txt
8686
User-agent: *
87-
# This project is delisted according to the Policy for Unofficial and Unmaintanied Projects
87+
# This project is delisted according to the Unofficial and Unmaintanied Project Policy
8888
# https://docs.readthedocs.io/en/stable/unofficial-projects.html
8989
Disallow: /
9090

0 commit comments

Comments
 (0)