|
| 1 | +Policy for Unofficial and Outdated Projects |
| 2 | +=========================================== |
| 3 | + |
| 4 | +This policy describes a process where we take actions against unmaintained and unofficial forks of project documentation. |
| 5 | + |
| 6 | +Rationale |
| 7 | +--------- |
| 8 | + |
| 9 | +There is often the case where a set of documentation has been built, |
| 10 | +and it is not the official set from the project. |
| 11 | +There are many reasons this can happen, |
| 12 | +including forks, old official docs that are unmaintained, and many other situations. |
| 13 | + |
| 14 | +The problem with old, outdated docs is that users will find them in Google, |
| 15 | +and get confused to the validity of them. |
| 16 | +Projects will then get support requests from people who are using an old and incorrect documentation version. |
| 17 | + |
| 18 | +We have this policy to allow project maintainers to request the *delisting* of forks that are old and outdated. |
| 19 | + |
| 20 | +Specification |
| 21 | +------------- |
| 22 | + |
| 23 | +The main idea behind this policy is that Read the Docs serves the community. Every |
| 24 | +user is invited to upload content under the Terms of Use, understanding that it |
| 25 | +is at the sole risk of the user. |
| 26 | + |
| 27 | +While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep that |
| 28 | +content accessible indefinitely in its published form. However, in certain |
| 29 | +edge cases the greater community's needs might outweigh the individual's |
| 30 | +expectation of continued publishing. |
| 31 | + |
| 32 | +The use cases covered by this policy are: |
| 33 | + |
| 34 | +Outdated docs |
| 35 | + Documentation that is not being actively maintained or updated. |
| 36 | + |
| 37 | +Unofficial forks |
| 38 | + Forks of a project documentation that are not linked to from the project in any way. |
| 39 | + |
| 40 | +Implementation |
| 41 | +-------------- |
| 42 | + |
| 43 | +Unofficial projects |
| 44 | +~~~~~~~~~~~~~~~~~~~ |
| 45 | + |
| 46 | +A project is considered *unofficial* when ALL of the following are met: |
| 47 | + |
| 48 | +* It is not hosted on an official domain of the project |
| 49 | +* It is not linked from the project's README, description, or source code |
| 50 | + |
| 51 | +Unmaintained projects |
| 52 | +~~~~~~~~~~~~~~~~~~~~~ |
| 53 | + |
| 54 | +A project is considered *unmaintained* when ALL of the following are met: |
| 55 | + |
| 56 | +* The project is only serving content from releases and commits of a project over 6 months old |
| 57 | + |
| 58 | +Reachability |
| 59 | +~~~~~~~~~~~~ |
| 60 | + |
| 61 | +for matters concerning projects that the user owns. |
| 62 | +In every case where contacting the user is necessary, |
| 63 | +the core team will reach out using one of the following means of contact: |
| 64 | + |
| 65 | +* E-mail address on file in the user's profile |
| 66 | +* E-mail address on the GitHub user account where the project is pointed |
| 67 | + |
| 68 | +The core team will stop trying to reach the user after 2 weeks and the user |
| 69 | +will be considered *unreachable*. |
| 70 | + |
| 71 | +Delisting of an abandoned project |
| 72 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 73 | + |
| 74 | +Projects that are determined to be *Unofficial* and *Unmaintained* will have a ``robots.txt`` file added that removes them from all search results. |
| 75 | + |
| 76 | +Projects will be delisted when ALL of the following: |
| 77 | + |
| 78 | +* The project has been determined *unmaintained* and *unofficial* by the rules described above |
| 79 | +* The candidate is able to demonstrate their own failed attempts to contact the |
| 80 | + existing owner |
| 81 | +* The project owner is *unreachable* by the Read the Docs team |
| 82 | +* The core team does not have any additional reservations. |
| 83 | + |
| 84 | +Requesting a project be delisted |
| 85 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 86 | + |
| 87 | +If you are the maintainer of a project, |
| 88 | +you can request that we delist an outdated, unmaintained set of docs with our :doc:`/support`. |
| 89 | + |
| 90 | +Prior art |
| 91 | +--------- |
| 92 | + |
| 93 | +This policy is inspired by our :doc:`abandoned-projects`. |
| 94 | +The Python Package Index (PyPI) policy for claiming abandoned packages |
| 95 | +(`PEP-0541 <https://www.python.org/dev/peps/pep-0541>`_) heavily |
| 96 | +influenced this policy. |
0 commit comments