Skip to content

Commit 9e7bcb7

Browse files
authored
Update style and copy on abandonment docs (#3406)
I went to look up our new policy and got confused :) "Maintainers" is a term I attribute to project maintainers, not the core team of Read the Docs. Because we refer to "core team" regularly, I updated that here. This also alters the style of the lists to be less formal legal structure and adds a couple pieces of reST that fit better.
1 parent 564bca7 commit 9e7bcb7

File tree

1 file changed

+30
-39
lines changed

1 file changed

+30
-39
lines changed

docs/abandoned-projects.rst

+30-39
Original file line numberDiff line numberDiff line change
@@ -3,100 +3,91 @@ Policy for Abandoned Projects
33

44
This policy describes the process by which a Read the Docs project name may be changed.
55

6-
76
Rationale
87
---------
98

109
Conflict between the current use of the name and a different suggested use of
1110
the same name occasionally arise. This document aims to provide general
1211
guidelines for solving the most typical cases of such conflicts.
1312

14-
1513
Specification
1614
-------------
1715

1816
The main idea behind this policy is that Read the Docs serves the community. Every
1917
user is invited to upload content under the Terms of Use, understanding that it
2018
is at the sole risk of the user.
2119

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
2422
edge cases the greater community's needs might outweigh the individual's
2523
expectation of ownership of a project name.
2624

2725
The use cases covered by this policy are:
2826

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
3730

31+
Active projects
32+
Resolving disputes over a name
3833

3934
Implementation
4035
--------------
4136

4237
Reachability
4338
~~~~~~~~~~~~
4439

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
4843
three times, using the following means of contact:
4944

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
5348

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
5550
will be considered *unreachable*.
5651

57-
5852
Abandoned projects
5953
~~~~~~~~~~~~~~~~~~
6054

6155
A project is considered *abandoned* when ALL of the following are met:
6256

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
6761
found).
6862

6963
All other projects are considered *active*.
7064

71-
7265
Renaming of an abandoned project
7366
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7467

7568
Projects are never renamed solely on the basis of abandonment.
7669

77-
An *abandoned* project can be renamed (by appending "-abandoned" and a
70+
An *abandoned* project can be renamed (by appending ``-abandoned`` and a
7871
uniquifying integer if needed) for purposes of reusing the name when ALL of the
7972
following are met:
8073

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.
9183

9284
Name conflict resolution for active projects
9385
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9486

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
9789
issue by respectful communication.
9890

99-
10091
Prior art
10192
---------
10293

0 commit comments

Comments
 (0)