From 81150bba848cf77ec954c16af832a65de458775d Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Mon, 14 Nov 2022 15:59:13 -0800 Subject: [PATCH 01/41] Add an initial policy for delisting unmaintained projects I'm not 100% in love with this content structure, but I think it's important to get this out. Closes https://github.com/readthedocs/readthedocs.org/issues/9130 --- docs/user/unofficial-projects.rst | 96 +++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 docs/user/unofficial-projects.rst diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst new file mode 100644 index 00000000000..d43dfe5a4ee --- /dev/null +++ b/docs/user/unofficial-projects.rst @@ -0,0 +1,96 @@ +Policy for Unofficial and Outdated Projects +=========================================== + +This policy describes a process where we take actions against unmaintained and unofficial forks of project documentation. + +Rationale +--------- + +There is often the case where a set of documentation has been built, +and it is not the official set from the project. +There are many reasons this can happen, +including forks, old official docs that are unmaintained, and many other situations. + +The problem with old, outdated docs is that users will find them in Google, +and get confused to the validity of them. +Projects will then get support requests from people who are using an old and incorrect documentation version. + +We have this policy to allow project maintainers to request the *delisting* of forks that are old and outdated. + +Specification +------------- + +The main idea behind this policy is that Read the Docs serves the community. Every +user is invited to upload content under the Terms of Use, understanding that it +is at the sole risk of the user. + +While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep that +content accessible indefinitely in its published form. However, in certain +edge cases the greater community's needs might outweigh the individual's +expectation of continued publishing. + +The use cases covered by this policy are: + +Outdated docs + Documentation that is not being actively maintained or updated. + +Unofficial forks + Forks of a project documentation that are not linked to from the project in any way. + +Implementation +-------------- + +Unofficial projects +~~~~~~~~~~~~~~~~~~~ + +A project is considered *unofficial* when ALL of the following are met: + +* It is not hosted on an official domain of the project +* It is not linked from the project's README, description, or source code + +Unmaintained projects +~~~~~~~~~~~~~~~~~~~~~ + +A project is considered *unmaintained* when ALL of the following are met: + +* The project is only serving content from releases and commits of a project over 6 months old + +Reachability +~~~~~~~~~~~~ + +for matters concerning projects that the user owns. +In every case where contacting the user is necessary, +the core team will reach out using one of the following means of contact: + +* E-mail address on file in the user's profile +* E-mail address on the GitHub user account where the project is pointed + +The core team will stop trying to reach the user after 2 weeks and the user +will be considered *unreachable*. + +Delisting of an abandoned project +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Projects that are determined to be *Unofficial* and *Unmaintained* will have a ``robots.txt`` file added that removes them from all search results. + +Projects will be delisted when ALL of the following: + +* The project has been determined *unmaintained* and *unofficial* by the rules described above +* The candidate is able to demonstrate their own failed attempts to contact the + existing owner +* The project owner is *unreachable* by the Read the Docs team +* The core team does not have any additional reservations. + +Requesting a project be delisted +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you are the maintainer of a project, +you can request that we delist an outdated, unmaintained set of docs with our :doc:`/support`. + +Prior art +--------- + +This policy is inspired by our :doc:`abandoned-projects`. +The Python Package Index (PyPI) policy for claiming abandoned packages +(`PEP-0541 `_) heavily +influenced this policy. From c5b6b1583c2da74fc8bc0b0e37ef92095efac559 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Mon, 14 Nov 2022 16:04:13 -0800 Subject: [PATCH 02/41] Move legalise to the bottom --- docs/user/unofficial-projects.rst | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index d43dfe5a4ee..662c155fae5 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -19,16 +19,6 @@ We have this policy to allow project maintainers to request the *delisting* of f Specification ------------- - -The main idea behind this policy is that Read the Docs serves the community. Every -user is invited to upload content under the Terms of Use, understanding that it -is at the sole risk of the user. - -While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep that -content accessible indefinitely in its published form. However, in certain -edge cases the greater community's needs might outweigh the individual's -expectation of continued publishing. - The use cases covered by this policy are: Outdated docs @@ -87,6 +77,18 @@ Requesting a project be delisted If you are the maintainer of a project, you can request that we delist an outdated, unmaintained set of docs with our :doc:`/support`. +Thinking behind the policy +-------------------------- + +The main idea behind this policy is that Read the Docs serves the community. Every +user is invited to upload content under the Terms of Use, understanding that it +is at the sole risk of the user. + +While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep that +content accessible indefinitely in its published form. However, in certain +edge cases the greater community's needs might outweigh the individual's +expectation of continued publishing. + Prior art --------- From fb045c43ae1e89bf3af5ef512dce01bbdbed0dd5 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Mon, 14 Nov 2022 16:05:26 -0800 Subject: [PATCH 03/41] A bit more clarify --- docs/user/unofficial-projects.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 662c155fae5..72898633911 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -7,7 +7,7 @@ Rationale --------- There is often the case where a set of documentation has been built, -and it is not the official set from the project. +and it is kept online but grows outdated over time. There are many reasons this can happen, including forks, old official docs that are unmaintained, and many other situations. From 15d53aa1843f9f0af68f128a3d39e65be5cdf51b Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Mon, 14 Nov 2022 16:24:11 -0800 Subject: [PATCH 04/41] Add to TOC --- docs/user/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/user/index.rst b/docs/user/index.rst index c47a6bf427e..a5ad8825b95 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -250,7 +250,8 @@ of Read the Docs and the larger software documentation ecosystem. * **Policies & Process**: :doc:`security` | :doc:`DMCA takedown policy ` | - :doc:`Policy for abandoned projects ` | + :doc:`/abandoned-projects` | + :doc:`/unofficial-projects` | :doc:`Release notes & changelog ` From 86a06dbb064c74f253f985ffc550c77756df38df Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Wed, 16 Nov 2022 12:32:18 +0100 Subject: [PATCH 05/41] Apply the most immediately uncomplicated suggestions from code review Co-authored-by: Manuel Kaufmann Co-authored-by: Anthony --- docs/user/unofficial-projects.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 72898633911..cbdd6741c34 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -1,17 +1,19 @@ Policy for Unofficial and Outdated Projects =========================================== -This policy describes a process where we take actions against unmaintained and unofficial forks of project documentation. +This policy describes a process where we take actions against unmaintained_ and unofficial_ forks of project documentation. + +.. _unmaintained: #unmaintained-projects +.. _unofficial: #unofficial-projects Rationale --------- -There is often the case where a set of documentation has been built, -and it is kept online but grows outdated over time. +Documentation projects may be kept online indefinitely, even though a newer version of the same project exists elsewhere. There are many reasons this can happen, including forks, old official docs that are unmaintained, and many other situations. -The problem with old, outdated docs is that users will find them in Google, +The problem with old, outdated docs is that users will find them in search results, and get confused to the validity of them. Projects will then get support requests from people who are using an old and incorrect documentation version. @@ -33,10 +35,11 @@ Implementation Unofficial projects ~~~~~~~~~~~~~~~~~~~ -A project is considered *unofficial* when ALL of the following are met: +A project is considered *unofficial* when it is not linked to or mentioned in *any* of the following places: -* It is not hosted on an official domain of the project -* It is not linked from the project's README, description, or source code +* Websites and domains associated with the project +* Social media accounts associated with the project +* The project's primary repository -- README files, repository description, or source code Unmaintained projects ~~~~~~~~~~~~~~~~~~~~~ From 9ffd9c884dcf46e81caff1b5279eda8dc6b76f56 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 15:54:32 +0100 Subject: [PATCH 06/41] Expand section on what "unmaintained" means --- docs/user/unofficial-projects.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index cbdd6741c34..fddf9fcad9f 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -44,9 +44,12 @@ A project is considered *unofficial* when it is not linked to or mentioned in *a Unmaintained projects ~~~~~~~~~~~~~~~~~~~~~ -A project is considered *unmaintained* when ALL of the following are met: +A project is considered *unmaintained* when ANY of the following are met: + +* The configured VCS repository is unreadable. This can happen if the repository is deleted, credentials are broken or the git host permanently unresponsive. +* The project is only serving content from releases and commits >6 months older than its source project (this happens with unmaintained forks). +* All builds have failed for >6 months. -* The project is only serving content from releases and commits of a project over 6 months old Reachability ~~~~~~~~~~~~ From dd70d1a1589a7a2667f1a1e6f3f41f55f2d5ebed Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 15:59:33 +0100 Subject: [PATCH 07/41] Add more cross-references for defined terms --- docs/user/unofficial-projects.rst | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index fddf9fcad9f..262755eff8e 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -3,9 +3,6 @@ Policy for Unofficial and Outdated Projects This policy describes a process where we take actions against unmaintained_ and unofficial_ forks of project documentation. -.. _unmaintained: #unmaintained-projects -.. _unofficial: #unofficial-projects - Rationale --------- @@ -54,27 +51,23 @@ A project is considered *unmaintained* when ANY of the following are met: Reachability ~~~~~~~~~~~~ -for matters concerning projects that the user owns. -In every case where contacting the user is necessary, -the core team will reach out using one of the following means of contact: +In every case where contacting the user is necessary, the core team will reach out using one of the following means of contact: * E-mail address on file in the user's profile * E-mail address on the GitHub user account where the project is pointed -The core team will stop trying to reach the user after 2 weeks and the user -will be considered *unreachable*. +The core team will stop trying to reach the user after 3 weeks and the user will be considered *unreachable*. Delisting of an abandoned project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Projects that are determined to be *Unofficial* and *Unmaintained* will have a ``robots.txt`` file added that removes them from all search results. +Projects that are determined to be unmaintained_ and unofficial_ will have a ``robots.txt`` file added that removes them from all search results. Projects will be delisted when ALL of the following: -* The project has been determined *unmaintained* and *unofficial* by the rules described above -* The candidate is able to demonstrate their own failed attempts to contact the - existing owner -* The project owner is *unreachable* by the Read the Docs team +* The project has been determined unmaintained_ and unofficial_ by the rules described above +* The candidate is able to demonstrate their own failed attempts to contact the existing owner +* The project owner is unreachable_ by the Read the Docs team * The core team does not have any additional reservations. Requesting a project be delisted @@ -102,3 +95,7 @@ This policy is inspired by our :doc:`abandoned-projects`. The Python Package Index (PyPI) policy for claiming abandoned packages (`PEP-0541 `_) heavily influenced this policy. + +.. _unmaintained: #unmaintained-projects +.. _unofficial: #unofficial-projects +.. _unreachable: #reachability From c8e535193b5d5a3c32b61c624662a85fa9533628 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 16:01:14 +0100 Subject: [PATCH 08/41] sembr --- docs/user/unofficial-projects.rst | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 262755eff8e..b4bce25f70c 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -79,22 +79,19 @@ you can request that we delist an outdated, unmaintained set of docs with our :d Thinking behind the policy -------------------------- -The main idea behind this policy is that Read the Docs serves the community. Every -user is invited to upload content under the Terms of Use, understanding that it -is at the sole risk of the user. +The main idea behind this policy is that Read the Docs serves the community. +Every user is invited to upload content under the Terms of Use, +understanding that it is at the sole risk of the user. -While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep that -content accessible indefinitely in its published form. However, in certain -edge cases the greater community's needs might outweigh the individual's -expectation of continued publishing. +While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep content accessible indefinitely in its published form. However, in certain edge cases, +the greater community's needs might outweigh the individual's expectation of continued publishing. Prior art --------- This policy is inspired by our :doc:`abandoned-projects`. The Python Package Index (PyPI) policy for claiming abandoned packages -(`PEP-0541 `_) heavily -influenced this policy. +(`PEP-0541 `_) heavily influenced this policy. .. _unmaintained: #unmaintained-projects .. _unofficial: #unofficial-projects From 325266372437c4fec4a31d80025df75c62d1b745 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 16:03:14 +0100 Subject: [PATCH 09/41] Adding linebreaks --- docs/user/unofficial-projects.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index b4bce25f70c..00ba69efa23 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -3,6 +3,7 @@ Policy for Unofficial and Outdated Projects This policy describes a process where we take actions against unmaintained_ and unofficial_ forks of project documentation. + Rationale --------- @@ -16,8 +17,10 @@ Projects will then get support requests from people who are using an old and inc We have this policy to allow project maintainers to request the *delisting* of forks that are old and outdated. + Specification ------------- + The use cases covered by this policy are: Outdated docs @@ -26,9 +29,11 @@ Outdated docs Unofficial forks Forks of a project documentation that are not linked to from the project in any way. + Implementation -------------- + Unofficial projects ~~~~~~~~~~~~~~~~~~~ @@ -38,6 +43,7 @@ A project is considered *unofficial* when it is not linked to or mentioned in *a * Social media accounts associated with the project * The project's primary repository -- README files, repository description, or source code + Unmaintained projects ~~~~~~~~~~~~~~~~~~~~~ @@ -58,6 +64,7 @@ In every case where contacting the user is necessary, the core team will reach o The core team will stop trying to reach the user after 3 weeks and the user will be considered *unreachable*. + Delisting of an abandoned project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -70,12 +77,14 @@ Projects will be delisted when ALL of the following: * The project owner is unreachable_ by the Read the Docs team * The core team does not have any additional reservations. + Requesting a project be delisted ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you are the maintainer of a project, you can request that we delist an outdated, unmaintained set of docs with our :doc:`/support`. + Thinking behind the policy -------------------------- @@ -86,6 +95,7 @@ understanding that it is at the sole risk of the user. While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep content accessible indefinitely in its published form. However, in certain edge cases, the greater community's needs might outweigh the individual's expectation of continued publishing. + Prior art --------- From 06ac18d7a3490ad1ea3f703e95bf087521c0b740 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 16:13:09 +0100 Subject: [PATCH 10/41] Remove "candidate" and make it a bit more clear that someone needs to submit a report --- docs/user/unofficial-projects.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 00ba69efa23..b05203d79b7 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -72,9 +72,9 @@ Projects that are determined to be unmaintained_ and unofficial_ will have a ``r Projects will be delisted when ALL of the following: -* The project has been determined unmaintained_ and unofficial_ by the rules described above -* The candidate is able to demonstrate their own failed attempts to contact the existing owner -* The project owner is unreachable_ by the Read the Docs team +* The project has been determined unmaintained_ and unofficial_ by the rules described above. +* The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owner. +* The project owner is unreachable_ by the Read the Docs team. * The core team does not have any additional reservations. From 01234ce67c8f58d147320efcb28cc6fbdbed4951 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 16:43:23 +0100 Subject: [PATCH 11/41] Add a template for emails --- docs/user/unofficial-projects.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index b05203d79b7..6fdfbe83f5b 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -24,7 +24,7 @@ Specification The use cases covered by this policy are: Outdated docs - Documentation that is not being actively maintained or updated. + Documentation that is not being actively maintained or updated. This means for instance that the source project has updates that are not reflected in the documentation or a newer official documentation exists elsewhere on the internet. Unofficial forks Forks of a project documentation that are not linked to from the project in any way. @@ -84,6 +84,18 @@ Requesting a project be delisted If you are the maintainer of a project, you can request that we delist an outdated, unmaintained set of docs with our :doc:`/support`. +Please include the following information: + +.. code-block:: text + + URL of unofficial and unmaintained documentation project: ... + URL of official documentation (if any): ... + URL of official source project website (if any): ... + URL of official source project repository (if any): ... + + Describe attempts of reaching the owner of the documentation project: + ... + Thinking behind the policy -------------------------- From d6f30d6da2a751027b387d8f2c8e4b232c655913 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 16:46:08 +0100 Subject: [PATCH 12/41] Move definitions to "specification" as @humitos suggested --- docs/user/unofficial-projects.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 6fdfbe83f5b..794e0748cf4 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -30,10 +30,6 @@ Unofficial forks Forks of a project documentation that are not linked to from the project in any way. -Implementation --------------- - - Unofficial projects ~~~~~~~~~~~~~~~~~~~ @@ -65,6 +61,10 @@ In every case where contacting the user is necessary, the core team will reach o The core team will stop trying to reach the user after 3 weeks and the user will be considered *unreachable*. +Implementation +-------------- + + Delisting of an abandoned project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 24bed4c58dbcddd03cffecf3dcfb25515853c90f Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 16:47:16 +0100 Subject: [PATCH 13/41] Move use cases to "Examples" under rationale --- docs/user/unofficial-projects.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 794e0748cf4..d17bb5de757 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -18,10 +18,10 @@ Projects will then get support requests from people who are using an old and inc We have this policy to allow project maintainers to request the *delisting* of forks that are old and outdated. -Specification -------------- +Examples +~~~~~~~~ -The use cases covered by this policy are: +Common cases covered by this policy are: Outdated docs Documentation that is not being actively maintained or updated. This means for instance that the source project has updates that are not reflected in the documentation or a newer official documentation exists elsewhere on the internet. @@ -30,6 +30,10 @@ Unofficial forks Forks of a project documentation that are not linked to from the project in any way. +Specification +------------- + + Unofficial projects ~~~~~~~~~~~~~~~~~~~ From 20ebb61b03f0c2bedf7f2b0d16acd6f1603a21e5 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 16:53:42 +0100 Subject: [PATCH 14/41] Adds robots.txt boilerplate --- docs/user/unofficial-projects.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index d17bb5de757..947134ea49d 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -72,7 +72,14 @@ Implementation Delisting of an abandoned project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Projects that are determined to be unmaintained_ and unofficial_ will have a ``robots.txt`` file added that removes them from all search results. +Projects that are determined to be unmaintained_ and unofficial_ will have a ``robots.txt`` file added that removes them from all search results: + +.. code-block:: text + + # robots.txt + User-agent: * + Disallow: / # Delists everything + Projects will be delisted when ALL of the following: From 3ddc4e649d89d67d7aec1e8aab3cd54bb6e792f9 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 16:59:59 +0100 Subject: [PATCH 15/41] Add a step that the source project is notified by RTD core team --- docs/user/unofficial-projects.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 947134ea49d..1290a296aee 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -83,10 +83,11 @@ Projects that are determined to be unmaintained_ and unofficial_ will have a ``r Projects will be delisted when ALL of the following: -* The project has been determined unmaintained_ and unofficial_ by the rules described above. * The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owner. +* The project has been determined unmaintained_ and unofficial_ by the rules described above. * The project owner is unreachable_ by the Read the Docs team. * The core team does not have any additional reservations. +* The core team notifies the source project's maintainers about changes made Requesting a project be delisted From 6cf0a1bb0d773e1722343e996be76f7f41267d84 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 17:19:40 +0100 Subject: [PATCH 16/41] resolve warning - include in TOC --- docs/user/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user/index.rst b/docs/user/index.rst index a5ad8825b95..b1bfa8277ac 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -284,6 +284,7 @@ of Read the Docs and the larger software documentation ecosystem. security dmca/index abandoned-projects + unofficial-projects changelog about From 3b03178c07abe26c98b073949fc105da5a11bccf Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 16 Nov 2022 19:45:58 +0100 Subject: [PATCH 17/41] Add a comment in robots.txt template --- docs/user/unofficial-projects.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 1290a296aee..a527fbdc387 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -78,7 +78,7 @@ Projects that are determined to be unmaintained_ and unofficial_ will have a ``r # robots.txt User-agent: * - Disallow: / # Delists everything + Disallow: / # This project is delisted according to the Policy for Unofficial and Unmaintanied Projects Projects will be delisted when ALL of the following: From 00b03375475ebb6e455922ca6e3c3727237b5a43 Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Thu, 17 Nov 2022 12:30:03 +0100 Subject: [PATCH 18/41] Update docs/user/unofficial-projects.rst --- docs/user/unofficial-projects.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index a527fbdc387..95fe5ff051c 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -1,4 +1,4 @@ -Policy for Unofficial and Outdated Projects +Policy for Unofficial and Unmaintained Projects =========================================== This policy describes a process where we take actions against unmaintained_ and unofficial_ forks of project documentation. From 66cc1ae8f3d070c8b8fe95c50536c75605644c88 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Thu, 17 Nov 2022 17:43:16 +0100 Subject: [PATCH 19/41] Adds a link in robots.txt to where the policy will presumably live --- docs/user/unofficial-projects.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 95fe5ff051c..4835e48d03e 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -1,5 +1,5 @@ Policy for Unofficial and Unmaintained Projects -=========================================== +=============================================== This policy describes a process where we take actions against unmaintained_ and unofficial_ forks of project documentation. @@ -78,7 +78,9 @@ Projects that are determined to be unmaintained_ and unofficial_ will have a ``r # robots.txt User-agent: * - Disallow: / # This project is delisted according to the Policy for Unofficial and Unmaintanied Projects + # This project is delisted according to the Policy for Unofficial and Unmaintanied Projects + # https://docs.readthedocs.io/en/stable/unofficial-projects.html + Disallow: / Projects will be delisted when ALL of the following: From 5aa69bf82feee6b5910aac5868d062e7829db34c Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Thu, 17 Nov 2022 21:24:34 +0100 Subject: [PATCH 20/41] Apply suggestions from @agjohnson code review Co-authored-by: Anthony --- docs/user/unofficial-projects.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 4835e48d03e..608ad9654c0 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -49,9 +49,9 @@ Unmaintained projects A project is considered *unmaintained* when ANY of the following are met: -* The configured VCS repository is unreadable. This can happen if the repository is deleted, credentials are broken or the git host permanently unresponsive. -* The project is only serving content from releases and commits >6 months older than its source project (this happens with unmaintained forks). -* All builds have failed for >6 months. +* The configured version control repository is unreadable. This can happen if the repository is deleted, credentials are broken or the Git host is permanently unresponsive. +* The project is only serving content from releases and commits 6 months or older than its source repository. +* All builds have failed for more than 6 months. Reachability @@ -83,7 +83,7 @@ Projects that are determined to be unmaintained_ and unofficial_ will have a ``r Disallow: / -Projects will be delisted when ALL of the following: +Projects will be delisted if they meet *all* of the following criteria: * The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owner. * The project has been determined unmaintained_ and unofficial_ by the rules described above. @@ -96,7 +96,7 @@ Requesting a project be delisted ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you are the maintainer of a project, -you can request that we delist an outdated, unmaintained set of docs with our :doc:`/support`. +you can request that we delist an outdated, unmaintained documentation with our :doc:`/support`. Please include the following information: From 55d3f2d8b08435852d419cff01571a99458a4e76 Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Thu, 17 Nov 2022 23:58:58 +0100 Subject: [PATCH 21/41] Update docs/user/unofficial-projects.rst Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> --- docs/user/unofficial-projects.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 608ad9654c0..9e393191d45 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -33,6 +33,16 @@ Unofficial forks Specification ------------- +High level overview +~~~~~~~~~~~~~~~~~ + +The process at a high level looks like: + +* A reporter emails us about a project they think is outdated and unofficial +* An RTD team member evaluates it to make sure it's outdated and unofficial, according to this policy +* We delist this project from search results and send an email to owners of the RTD project +* If a project owner objects, we evaluate their evidence and make a final decision + Unofficial projects ~~~~~~~~~~~~~~~~~~~ From 5d43f5fcc1ab5d2aba7e7dc54f43d57dde62b9ce Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Mon, 21 Nov 2022 20:49:00 +0100 Subject: [PATCH 22/41] Remove procedure to notify upstream maintainers --- docs/user/unofficial-projects.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 4835e48d03e..dddae9ed41e 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -89,7 +89,6 @@ Projects will be delisted when ALL of the following: * The project has been determined unmaintained_ and unofficial_ by the rules described above. * The project owner is unreachable_ by the Read the Docs team. * The core team does not have any additional reservations. -* The core team notifies the source project's maintainers about changes made Requesting a project be delisted From 27ee5a9b296a4963d1528564a9d2aea9ad7d9eed Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Mon, 21 Nov 2022 20:53:07 +0100 Subject: [PATCH 23/41] Change Specification to Definitions --- docs/user/unofficial-projects.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index dddae9ed41e..016a72d3e31 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -30,8 +30,8 @@ Unofficial forks Forks of a project documentation that are not linked to from the project in any way. -Specification -------------- +Definitions +----------- Unofficial projects From dd1eadb6db78a07631ecd66446c771fb6d69c84f Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Mon, 21 Nov 2022 20:54:43 +0100 Subject: [PATCH 24/41] Move High-level Overview to Rationale --- docs/user/unofficial-projects.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index aec03bcd0db..6fb0cd84fb6 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -30,11 +30,8 @@ Unofficial forks Forks of a project documentation that are not linked to from the project in any way. -Definitions ------------ - High level overview -~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~ The process at a high level looks like: @@ -44,6 +41,10 @@ The process at a high level looks like: * If a project owner objects, we evaluate their evidence and make a final decision +Definitions +----------- + + Unofficial projects ~~~~~~~~~~~~~~~~~~~ From 0c967234dab121e050a03478660d2aff8fb1e055 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Mon, 21 Nov 2022 21:01:20 +0100 Subject: [PATCH 25/41] Add a definition of source project --- docs/user/unofficial-projects.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 6fb0cd84fb6..7d7ae9bb698 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -45,6 +45,17 @@ Definitions ----------- +Source project +~~~~~~~~~~~~~~ + +For a given documentation project to be assessed, the *source project* comes into question. This is defined as: + +* The origin project from which the documentation project's repository was forked (if forked). +* The origin project from which the documentation project was copied (if not forked but evidently copied). +* The original project which the documentation project refers as the subject of documentation. +* Any other project that is understood by the core team to be a the *source project*. + + Unofficial projects ~~~~~~~~~~~~~~~~~~~ From 0746c8ca62f715f8c0f7b3c364bd28ac5e9d2b00 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Mon, 21 Nov 2022 21:05:50 +0100 Subject: [PATCH 26/41] Delisting with notification. Step added to take no further action if unreachable. Step added that actions may be taken if reachable --- docs/user/unofficial-projects.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 7d7ae9bb698..ef4932c2085 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -109,9 +109,10 @@ Projects will be delisted if they meet *all* of the following criteria: * The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owner. * The project has been determined unmaintained_ and unofficial_ by the rules described above. -* The project owner is unreachable_ by the Read the Docs team. +* The project owner is notified by the Read the Docs team. * The core team does not have any additional reservations. - +* If the project owner is unreachable_ by the Read the Docs team, no further action is taken. +* If the project owner responds, their response will be taken into account by the core team and it may be listed again if the criteria are met. Requesting a project be delisted ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 80186310e3deeb78260b0bd3ee6864b925aab70b Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Mon, 21 Nov 2022 21:10:17 +0100 Subject: [PATCH 27/41] Talk mostly of "owner" in plural, there might be several people maintaining a documentation project --- docs/user/unofficial-projects.rst | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index ef4932c2085..3959f733aba 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -15,7 +15,7 @@ The problem with old, outdated docs is that users will find them in search resul and get confused to the validity of them. Projects will then get support requests from people who are using an old and incorrect documentation version. -We have this policy to allow project maintainers to request the *delisting* of forks that are old and outdated. +We have this policy to allow a reporter to request the *delisting* of forks that are old and outdated. Examples @@ -107,18 +107,17 @@ Projects that are determined to be unmaintained_ and unofficial_ will have a ``r Projects will be delisted if they meet *all* of the following criteria: -* The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owner. +* The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owners. * The project has been determined unmaintained_ and unofficial_ by the rules described above. -* The project owner is notified by the Read the Docs team. +* The project owners is notified by the Read the Docs team. * The core team does not have any additional reservations. -* If the project owner is unreachable_ by the Read the Docs team, no further action is taken. -* If the project owner responds, their response will be taken into account by the core team and it may be listed again if the criteria are met. +* If the project owners are unreachable_ by the Read the Docs team, no further action is taken. +* If the any of the project owners respond, their response will be taken into account by the core team and it may be listed again if the criteria are met. Requesting a project be delisted ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you are the maintainer of a project, -you can request that we delist an outdated, unmaintained documentation with our :doc:`/support`. +You can request that we delist an outdated, unmaintained documentation with our :doc:`/support`. Please include the following information: @@ -129,7 +128,7 @@ Please include the following information: URL of official source project website (if any): ... URL of official source project repository (if any): ... - Describe attempts of reaching the owner of the documentation project: + Describe attempts of reaching the owner(s) of the documentation project: ... From 98ae9b01f8f884156d1640cf30e6d62301eeae09 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Mon, 21 Nov 2022 21:12:23 +0100 Subject: [PATCH 28/41] Remove SOME stuff, we aren't going to seriously validate that --- docs/user/unofficial-projects.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 3959f733aba..ee986cd987f 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -62,7 +62,6 @@ Unofficial projects A project is considered *unofficial* when it is not linked to or mentioned in *any* of the following places: * Websites and domains associated with the project -* Social media accounts associated with the project * The project's primary repository -- README files, repository description, or source code From 5ff425980d676430af54cdf205cc28471b494c43 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Mon, 21 Nov 2022 21:13:15 +0100 Subject: [PATCH 29/41] Remove examples section, it doesn't fill much purpose now --- docs/user/unofficial-projects.rst | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index ee986cd987f..df17f19bc73 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -18,18 +18,6 @@ Projects will then get support requests from people who are using an old and inc We have this policy to allow a reporter to request the *delisting* of forks that are old and outdated. -Examples -~~~~~~~~ - -Common cases covered by this policy are: - -Outdated docs - Documentation that is not being actively maintained or updated. This means for instance that the source project has updates that are not reflected in the documentation or a newer official documentation exists elsewhere on the internet. - -Unofficial forks - Forks of a project documentation that are not linked to from the project in any way. - - High level overview ~~~~~~~~~~~~~~~~~~~ From 682d3a2ee8465fdfb63a9e9c80fbfeceba4b35e9 Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Tue, 22 Nov 2022 13:55:32 +0100 Subject: [PATCH 30/41] Apply suggestions from @humitos and @erichholscher Co-authored-by: Manuel Kaufmann Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> --- docs/user/unofficial-projects.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index df17f19bc73..447faf9d2ef 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -23,9 +23,9 @@ High level overview The process at a high level looks like: -* A reporter emails us about a project they think is outdated and unofficial -* An RTD team member evaluates it to make sure it's outdated and unofficial, according to this policy -* We delist this project from search results and send an email to owners of the RTD project +* A reporter contacts us about a project they think is outdated and unofficial +* A Read the Docs team member evaluates it to make sure it's outdated and unofficial, according to this policy +* We delist this project from search results and send an email to owners of the Read the Docs project * If a project owner objects, we evaluate their evidence and make a final decision @@ -47,7 +47,7 @@ For a given documentation project to be assessed, the *source project* comes int Unofficial projects ~~~~~~~~~~~~~~~~~~~ -A project is considered *unofficial* when it is not linked to or mentioned in *any* of the following places: +A project is considered *unofficial* when it is not linked to or mentioned in ANY of these places: * Websites and domains associated with the project * The project's primary repository -- README files, repository description, or source code @@ -96,15 +96,15 @@ Projects will be delisted if they meet *all* of the following criteria: * The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owners. * The project has been determined unmaintained_ and unofficial_ by the rules described above. -* The project owners is notified by the Read the Docs team. +* The project owners are notified by the Read the Docs team. * The core team does not have any additional reservations. * If the project owners are unreachable_ by the Read the Docs team, no further action is taken. -* If the any of the project owners respond, their response will be taken into account by the core team and it may be listed again if the criteria are met. +* If any of the project owners respond, their response will be taken into account by the core team and it may be listed again if the criteria are met. Requesting a project be delisted ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can request that we delist an outdated, unmaintained documentation with our :doc:`/support`. +You can request that we delist an outdated, unmaintained documentation by contacting our :doc:`/support`. Please include the following information: @@ -112,8 +112,8 @@ Please include the following information: URL of unofficial and unmaintained documentation project: ... URL of official documentation (if any): ... - URL of official source project website (if any): ... - URL of official source project repository (if any): ... + URL of official project website (if any): ... + URL of official project repository (if any): ... Describe attempts of reaching the owner(s) of the documentation project: ... From 054a2f14aebbc6bc43ead52436cad0ed9e5d7dad Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Tue, 22 Nov 2022 14:19:29 +0100 Subject: [PATCH 31/41] reference Terms of Service doc --- docs/user/unofficial-projects.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 447faf9d2ef..e81ebb84232 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -123,7 +123,7 @@ Thinking behind the policy -------------------------- The main idea behind this policy is that Read the Docs serves the community. -Every user is invited to upload content under the Terms of Use, +Every user is invited to upload content under :doc:`/terms-of-service`, understanding that it is at the sole risk of the user. While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep content accessible indefinitely in its published form. However, in certain edge cases, From 561d135a4f458814d1cd363a1f81d0489cc96965 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Tue, 22 Nov 2022 15:44:53 +0100 Subject: [PATCH 32/41] Move delisting section --- docs/user/unofficial-projects.rst | 39 ++++++++++++++++--------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index e81ebb84232..5a17742b741 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -78,8 +78,26 @@ Implementation -------------- -Delisting of an abandoned project -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Requesting a project be delisted +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can request that we delist an outdated, unmaintained documentation by contacting our :doc:`/support`. + +Please include the following information: + +.. code-block:: text + + URL of unofficial and unmaintained documentation project: ... + URL of official documentation (if any): ... + URL of official project website (if any): ... + URL of official project repository (if any): ... + + Describe attempts of reaching the owner(s) of the documentation project: + ... + + +Delisting +~~~~~~~~~ Projects that are determined to be unmaintained_ and unofficial_ will have a ``robots.txt`` file added that removes them from all search results: @@ -101,23 +119,6 @@ Projects will be delisted if they meet *all* of the following criteria: * If the project owners are unreachable_ by the Read the Docs team, no further action is taken. * If any of the project owners respond, their response will be taken into account by the core team and it may be listed again if the criteria are met. -Requesting a project be delisted -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can request that we delist an outdated, unmaintained documentation by contacting our :doc:`/support`. - -Please include the following information: - -.. code-block:: text - - URL of unofficial and unmaintained documentation project: ... - URL of official documentation (if any): ... - URL of official project website (if any): ... - URL of official project repository (if any): ... - - Describe attempts of reaching the owner(s) of the documentation project: - ... - Thinking behind the policy -------------------------- From c023902cd4a00d72a05bac00c588c794e89d2d94 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Tue, 22 Nov 2022 15:45:28 +0100 Subject: [PATCH 33/41] Remove step outlining what happens if "unreachable" since nothing happens --- docs/user/unofficial-projects.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 5a17742b741..ed0dcb57600 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -116,7 +116,6 @@ Projects will be delisted if they meet *all* of the following criteria: * The project has been determined unmaintained_ and unofficial_ by the rules described above. * The project owners are notified by the Read the Docs team. * The core team does not have any additional reservations. -* If the project owners are unreachable_ by the Read the Docs team, no further action is taken. * If any of the project owners respond, their response will be taken into account by the core team and it may be listed again if the criteria are met. From e87570c6f0f6c1e461f2d505c037bd5d40ec3137 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Tue, 22 Nov 2022 15:46:37 +0100 Subject: [PATCH 34/41] Remove definition of "Unreachable" since it's not in use --- docs/user/unofficial-projects.rst | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index ed0dcb57600..b3512e3d46b 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -63,17 +63,6 @@ A project is considered *unmaintained* when ANY of the following are met: * All builds have failed for more than 6 months. -Reachability -~~~~~~~~~~~~ - -In every case where contacting the user is necessary, the core team will reach out using one of the following means of contact: - -* E-mail address on file in the user's profile -* E-mail address on the GitHub user account where the project is pointed - -The core team will stop trying to reach the user after 3 weeks and the user will be considered *unreachable*. - - Implementation -------------- @@ -139,4 +128,3 @@ The Python Package Index (PyPI) policy for claiming abandoned packages .. _unmaintained: #unmaintained-projects .. _unofficial: #unofficial-projects -.. _unreachable: #reachability From 0756f3c794ffc0248f95e901f54a2fb9ad1c1279 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Tue, 22 Nov 2022 17:11:58 +0100 Subject: [PATCH 35/41] Remove definition of Source Project --- docs/user/unofficial-projects.rst | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index b3512e3d46b..4c41d32a36a 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -33,17 +33,6 @@ Definitions ----------- -Source project -~~~~~~~~~~~~~~ - -For a given documentation project to be assessed, the *source project* comes into question. This is defined as: - -* The origin project from which the documentation project's repository was forked (if forked). -* The origin project from which the documentation project was copied (if not forked but evidently copied). -* The original project which the documentation project refers as the subject of documentation. -* Any other project that is understood by the core team to be a the *source project*. - - Unofficial projects ~~~~~~~~~~~~~~~~~~~ @@ -59,7 +48,7 @@ Unmaintained projects A project is considered *unmaintained* when ANY of the following are met: * The configured version control repository is unreadable. This can happen if the repository is deleted, credentials are broken or the Git host is permanently unresponsive. -* The project is only serving content from releases and commits 6 months or older than its source repository. +* The project is only serving content from releases and commits 6 months or older. * All builds have failed for more than 6 months. @@ -99,7 +88,7 @@ Projects that are determined to be unmaintained_ and unofficial_ will have a ``r Disallow: / -Projects will be delisted if they meet *all* of the following criteria: +Projects will be delisted if they meet ALL of the following criteria: * The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owners. * The project has been determined unmaintained_ and unofficial_ by the rules described above. From dac7f61dee4c674a6e2428e5fac1030e01abdccf Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Tue, 22 Nov 2022 19:11:55 +0100 Subject: [PATCH 36/41] Update docs/user/unofficial-projects.rst Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> --- docs/user/unofficial-projects.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 4c41d32a36a..46fe4fb12d3 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -92,9 +92,14 @@ Projects will be delisted if they meet ALL of the following criteria: * The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owners. * The project has been determined unmaintained_ and unofficial_ by the rules described above. -* The project owners are notified by the Read the Docs team. * The core team does not have any additional reservations. -* If any of the project owners respond, their response will be taken into account by the core team and it may be listed again if the criteria are met. + +The Read the Docs team will do the following actions when a project is delisted: + +* Notify the Read the Docs project owners via email about the delisting. +* Add the ``robots.txt`` file to be served on the project domain. + +If any of the project owners respond, their response will be taken into account, and the delisting might be reversed. Thinking behind the policy From a53cd0b7d41e4d2ca8398f1548119a485974e533 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 23 Nov 2022 12:27:12 +0100 Subject: [PATCH 37/41] Add cross-references to Project Policies --- docs/user/abandoned-projects.rst | 2 ++ docs/user/unofficial-projects.rst | 1 + 2 files changed, 3 insertions(+) diff --git a/docs/user/abandoned-projects.rst b/docs/user/abandoned-projects.rst index 49f965c5072..756384caca3 100644 --- a/docs/user/abandoned-projects.rst +++ b/docs/user/abandoned-projects.rst @@ -3,6 +3,8 @@ Policy for Abandoned Projects This policy describes the process by which a Read the Docs project name may be changed. +.. tip:: If you are reporting a project but a name change does not solve the issue, please see :doc:`/unofficial-projects`. + Rationale --------- diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 46fe4fb12d3..10d1d4e7ce1 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -3,6 +3,7 @@ Policy for Unofficial and Unmaintained Projects This policy describes a process where we take actions against unmaintained_ and unofficial_ forks of project documentation. +.. tip:: If you want to report an Abandoned project in order to free up its name (slug), please see :doc:`/abandoned-projects`. Rationale --------- From 0f2b70cc0bf948c300cecdfe6a1d7ddb7289c374 Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Wed, 23 Nov 2022 15:11:58 +0100 Subject: [PATCH 38/41] Apply suggestions from code review Co-authored-by: Manuel Kaufmann --- docs/user/unofficial-projects.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 10d1d4e7ce1..064957c1b0b 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -3,7 +3,7 @@ Policy for Unofficial and Unmaintained Projects This policy describes a process where we take actions against unmaintained_ and unofficial_ forks of project documentation. -.. tip:: If you want to report an Abandoned project in order to free up its name (slug), please see :doc:`/abandoned-projects`. +.. tip:: If you want to free up a project's :term:`slug` and gain access over it, please see :doc:`/abandoned-projects`. Rationale --------- From d1e9f6cd64f8c778eb95965f89e001845f49e59b Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Wed, 23 Nov 2022 15:59:28 +0100 Subject: [PATCH 39/41] Update docs/user/abandoned-projects.rst Co-authored-by: Manuel Kaufmann --- docs/user/abandoned-projects.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/abandoned-projects.rst b/docs/user/abandoned-projects.rst index 756384caca3..8db51b74b1c 100644 --- a/docs/user/abandoned-projects.rst +++ b/docs/user/abandoned-projects.rst @@ -1,7 +1,7 @@ Policy for Abandoned Projects ============================= -This policy describes the process by which a Read the Docs project name may be changed. +This policy describes the process by which a Read the Docs project :term:`slug` may be changed. .. tip:: If you are reporting a project but a name change does not solve the issue, please see :doc:`/unofficial-projects`. From cdb308226b0fa4181e1285628546a824634c1c0e Mon Sep 17 00:00:00 2001 From: Benjamin Balder Bach Date: Wed, 23 Nov 2022 20:16:05 +0100 Subject: [PATCH 40/41] Update docs/user/abandoned-projects.rst Co-authored-by: Manuel Kaufmann --- docs/user/abandoned-projects.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/abandoned-projects.rst b/docs/user/abandoned-projects.rst index 8db51b74b1c..5739639d685 100644 --- a/docs/user/abandoned-projects.rst +++ b/docs/user/abandoned-projects.rst @@ -3,7 +3,7 @@ Policy for Abandoned Projects This policy describes the process by which a Read the Docs project :term:`slug` may be changed. -.. tip:: If you are reporting a project but a name change does not solve the issue, please see :doc:`/unofficial-projects`. +.. tip:: If you want to de-list a project's fork from search results, please see :doc:`/unofficial-projects`. Rationale --------- From 9d29116a82cfa2768f5fb570984660c7eb282a1d Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 23 Nov 2022 20:23:08 +0100 Subject: [PATCH 41/41] ANY and ALL => **any** or **all** --- docs/user/unofficial-projects.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user/unofficial-projects.rst b/docs/user/unofficial-projects.rst index 064957c1b0b..374a04da69e 100644 --- a/docs/user/unofficial-projects.rst +++ b/docs/user/unofficial-projects.rst @@ -37,7 +37,7 @@ Definitions Unofficial projects ~~~~~~~~~~~~~~~~~~~ -A project is considered *unofficial* when it is not linked to or mentioned in ANY of these places: +A project is considered *unofficial* when it is not linked to or mentioned in **any** of these places: * Websites and domains associated with the project * The project's primary repository -- README files, repository description, or source code @@ -46,7 +46,7 @@ A project is considered *unofficial* when it is not linked to or mentioned in AN Unmaintained projects ~~~~~~~~~~~~~~~~~~~~~ -A project is considered *unmaintained* when ANY of the following are met: +A project is considered *unmaintained* when **any** of the following are met: * The configured version control repository is unreadable. This can happen if the repository is deleted, credentials are broken or the Git host is permanently unresponsive. * The project is only serving content from releases and commits 6 months or older. @@ -89,7 +89,7 @@ Projects that are determined to be unmaintained_ and unofficial_ will have a ``r Disallow: / -Projects will be delisted if they meet ALL of the following criteria: +Projects will be delisted if they meet **all** of the following criteria: * The person who submits the report of the unmaintained_ and unofficial_ project also demonstrates failed attempts to contact the existing owners. * The project has been determined unmaintained_ and unofficial_ by the rules described above.