Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove project's description field #5482

Closed
wants to merge 6 commits into from
Closed

Remove project's description field #5482

wants to merge 6 commits into from

Conversation

dojutsu-user
Copy link
Member

Closes #3689

dojutsu-user
dojutsu-user commented Mar 18, 2019
View reviewed changes
requirements/pip.txt
@@ -80,7 +80,6 @@ django-formtools==2.1
# https://github.com/rtfd/readthedocs.org/issues/3999
docker==3.1.3 # pyup: ignore

django-textclassifier==1.0
Copy link
Member Author

Choose a reason for hiding this comment

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

This is not needed anymore.

Copy link
Contributor

Choose a reason for hiding this comment

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

I believe this is used for spam project detection. I do worry that we'd get more spam if we don't run any detection. Perhaps we could run it on the name of the project. @agjohnson?

Copy link
Member Author

Choose a reason for hiding this comment

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

@davidfischer
There's an open PR for this. #5038

readthedocs/templates/projects/index.rst.html
@@ -1,11 +0,0 @@
{% load projects_tags %}{{ project.name|heading|safe }}
Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't find any use case for this file.

Copy link
Member Author

Choose a reason for hiding this comment

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

@stsewd is this file required?

@stsewd
Copy link
Member

stsewd commented Mar 18, 2019 •
edited
Loading

I think you need to keep this fields in the api response, see the discussion in the issue and the previous PR

@dojutsu-user
Copy link
Member Author

@stsewd
I didn't remove the field from the ProjectSerializer.
https://github.com/rtfd/readthedocs.org/blob/724c6cbddde1819d77521ce281b3d1097b85e5fe/readthedocs/restapi/serializers.py#L16-L32

dojutsu-user
dojutsu-user commented Mar 20, 2019
View reviewed changes
readthedocs/restapi/serializers.py
"""
Forcing the description field to be an empty string.

See https://github.com/rtfd/readthedocs.org/issues/3689.
Copy link
Member Author

Choose a reason for hiding this comment

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

Forcing the description to be an empty string in the API response. This was done as per this comment.

@dojutsu-user dojutsu-user mentioned this pull request Mar 20, 2019
Merged
@stale
Copy link

stale bot commented May 8, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label May 8, 2019
@dojutsu-user
Copy link
Member Author

Still valid... I think.

@stale stale bot removed the Status: stale Issue will be considered inactive soon label May 8, 2019
@humitos
Copy link
Member

humitos commented May 30, 2019

I remember that we talked in person about this, but I'm not really sure what was the path that we decided, @stsewd do you remember? Marking as Design Decision until then.

@humitos humitos added the Needed: design decision A core team decision is required label May 30, 2019
@stsewd
Copy link
Member

stsewd commented May 30, 2019

I don't think we talked about this in person, but there was a conversation about this, what I remember (or I think I remember): hide the current field, the remove it from the db, but the api endpoints should remain (return empty or None)

stsewd added a commit that referenced this pull request Jun 11, 2020
@stsewd
Project: make description shorter
3718abb 
Next step is to migrate existing long descriptions
and making this a constraint in the db.

Half solves #3689
Closes #5482
@stsewd stsewd mentioned this pull request Jun 11, 2020
Merged
stsewd added a commit that referenced this pull request Jun 11, 2020
@stsewd
Project: make description shorter
03a8c10 
Next step is to migrate existing long descriptions
and making this a constraint in the db.

Half solves #3689
Closes #5482
@stsewd stsewd closed this in #7186 Jun 12, 2020
stsewd added a commit that referenced this pull request Jun 12, 2020
@stsewd
Project: make description shorter (#7186)
0bbe2e6 
Next step is to migrate existing long descriptions
and making this a constraint in the db.

Half solves #3689
Closes #5482
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davidfischer davidfischer davidfischer left review comments

Assignees
No one assigned
Labels
Needed: design decision A core team decision is required
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove project description field
4 participants
@dojutsu-user @stsewd @humitos @davidfischer