Skip to content

Support delisting of projects #10060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Feb 28, 2023

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Feb 22, 2023

Adds support to delist projects that are unmaintained and unofficial, per policy: https://docs.readthedocs.io/en/stable/unofficial-projects.html

  • Add new field Project.delisted
  • Remove projects from search engine indexing (robots.txt)
  • Remove from ElasticSearch indexing
  • Show "delisted" status in Dashboard

Fixes https://github.com/readthedocs/meta/issues/99

@benjaoming benjaoming added Feature New feature Accepted Accepted issue on our roadmap labels Feb 22, 2023
@benjaoming benjaoming requested review from a team as code owners February 22, 2023 12:46
@benjaoming benjaoming changed the title Support unlisting of projects Support delisting of projects Feb 22, 2023
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great start! It's pretty close with a couple tweaks, and a test 👍

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty close to me 👍🏼 . Good work!

@ericholscher
Copy link
Member

ericholscher commented Feb 27, 2023

We should definitely get it in next week if we can. Let's drop all the search changes here, and move that discussion here: https://github.com/readthedocs/readthedocs-ext/issues/461#issuecomment-1444063694

@benjaoming benjaoming requested review from humitos and stsewd February 28, 2023 13:12
@benjaoming
Copy link
Contributor Author

We've resolved issues around ES indexing for now by pushing them to https://github.com/readthedocs/readthedocs-ext/issues/461

There isn't any other outstanding items here, so would be great with a review (and possibly merge) @humitos or @stsewd ?

Btw bumped into an interesting use-case today where someone wanted to opt out of in-doc search, but likely not global/dashboard search. We'll probably be back at defining what "delisted" means, and maybe even expose it in the UI - but I think that it's okay to say that "delisted" is currently a general option and everything else will be easy to extend on top of this.

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to merge this because I was hoping to ship it this week 👍

@ericholscher ericholscher merged commit 73f0ab5 into readthedocs:main Feb 28, 2023
@benjaoming benjaoming deleted the unlist-unofficial-projects branch February 28, 2023 14:39
@benjaoming
Copy link
Contributor Author

great @ericholscher 👍 I was aiming for someone in an earlier timezone to make it before release :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Feature New feature
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants