@@ -3,100 +3,91 @@ Policy for Abandoned Projects
3
3
4
4
This policy describes the process by which a Read the Docs project name may be changed.
5
5
6
-
7
6
Rationale
8
7
---------
9
8
10
9
Conflict between the current use of the name and a different suggested use of
11
10
the same name occasionally arise. This document aims to provide general
12
11
guidelines for solving the most typical cases of such conflicts.
13
12
14
-
15
13
Specification
16
14
-------------
17
15
18
16
The main idea behind this policy is that Read the Docs serves the community. Every
19
17
user is invited to upload content under the Terms of Use, understanding that it
20
18
is at the sole risk of the user.
21
19
22
- While Read the Docs is not a backup service, the maintainers do their best to keep that
23
- content accessible indefinitely in its published form. However, in certain
20
+ While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep that
21
+ content accessible indefinitely in its published form. However, in certain
24
22
edge cases the greater community's needs might outweigh the individual's
25
23
expectation of ownership of a project name.
26
24
27
25
The use cases covered by this policy are:
28
26
29
- * Abandoned projects:
30
-
31
- * renaming a project so that the original project name can be used by a
32
- different project.
33
-
34
- * Active projects:
35
-
36
- * resolving disputes over a name.
27
+ Abandoned projects
28
+ Renaming a project so that the original project name can be used by a
29
+ different project
37
30
31
+ Active projects
32
+ Resolving disputes over a name
38
33
39
34
Implementation
40
35
--------------
41
36
42
37
Reachability
43
38
~~~~~~~~~~~~
44
39
45
- The user of Read the Docs is solely responsible for being reachable by the maintainers
46
- for matters concerning projects that the user owns. In every case where
47
- contacting the user is necessary, the maintainers will try to do so at least
40
+ The user of Read the Docs is solely responsible for being reachable by the core team
41
+ for matters concerning projects that the user owns. In every case where
42
+ contacting the user is necessary, the core team will try to do so at least
48
43
three times, using the following means of contact:
49
44
50
- * e -mail address on file in the user's profile;
51
- * e -mail addresses found in the given project's documentation; and
52
- * e -mail address on the project's home page.
45
+ * E -mail address on file in the user's profile
46
+ * E -mail addresses found in the given project's documentation
47
+ * E -mail address on the project's home page
53
48
54
- The maintainers will stop trying to reach the user after six weeks and the user
49
+ The core team will stop trying to reach the user after six weeks and the user
55
50
will be considered *unreachable *.
56
51
57
-
58
52
Abandoned projects
59
53
~~~~~~~~~~~~~~~~~~
60
54
61
55
A project is considered *abandoned * when ALL of the following are met:
62
56
63
- * owner is unreachable (see Reachability above);
64
- * The project has no proper documentation being served (no successful builds); or
65
- * no releases within the past twelve months; and
66
- * no activity from the owner on the project's home page (or no home page
57
+ * Owner is unreachable (see ` Reachability `_)
58
+ * The project has no proper documentation being served (no successful builds) or
59
+ does not have any releases within the past twelve months
60
+ * No activity from the owner on the project's home page (or no home page
67
61
found).
68
62
69
63
All other projects are considered *active *.
70
64
71
-
72
65
Renaming of an abandoned project
73
66
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74
67
75
68
Projects are never renamed solely on the basis of abandonment.
76
69
77
- An *abandoned * project can be renamed (by appending " -abandoned" and a
70
+ An *abandoned * project can be renamed (by appending `` -abandoned `` and a
78
71
uniquifying integer if needed) for purposes of reusing the name when ALL of the
79
72
following are met:
80
73
81
- * the project has been determined *abandoned * by the rules described above;
82
- * the candidate is able to demonstrate their own failed attempts to contact the
83
- existing owner;
84
- * the candidate is able to demonstrate that the project suggested to reuse the
85
- name already exists and meets notability requirements;
86
- * the candidate is able to demonstrate why a fork under a different name is not
87
- an acceptable workaround;
88
- * the project has fewer than 100 monthly pageviews; and
89
- * the maintainers do not have any additional reservations.
90
-
74
+ * The project has been determined *abandoned * by the rules described above
75
+ * The candidate is able to demonstrate their own failed attempts to contact the
76
+ existing owner
77
+ * The candidate is able to demonstrate that the project suggested to reuse the
78
+ name already exists and meets notability requirements
79
+ * The candidate is able to demonstrate why a fork under a different name is not
80
+ an acceptable workaround
81
+ * The project has fewer than 100 monthly pageviews
82
+ * The core team does not have any additional reservations.
91
83
92
84
Name conflict resolution for active projects
93
85
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94
86
95
- The maintainers of Read the Docs are not arbiters in disputes around *active * projects.
96
- The maintainers recommend users to get in touch with each other and solve the
87
+ The core team of Read the Docs are not arbiters in disputes around *active * projects.
88
+ The core team recommends users to get in touch with each other and solve the
97
89
issue by respectful communication.
98
90
99
-
100
91
Prior art
101
92
---------
102
93
0 commit comments