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.

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

Allow change of project slug #1440

Closed
gregmuellegger opened this issue Jul 16, 2015 · 10 comments
Closed

Allow change of project slug #1440

gregmuellegger opened this issue Jul 16, 2015 · 10 comments
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Milestone

Comments

@gregmuellegger
Copy link
Contributor

We should make it possible to change the slug of a project. There are valid
reasons for it.

This was reported by @nanuxbe in #327. She wrote:

BitBucket is one example of a name change leading to a slug change.
I can see the need of keeping the slug stable as for search engine and external links but this is also the reason why changing the slug can be important as urls are very important to search-engines. Here's my current situation and why I'm interested in the topic:
I recently had to rename a project because the project's name was a slur word in some language which I was not aware of at time of creation.
Now that the project had been renamed I really don't want that project's read-the-docs pop up as search results for that slur word but in keeping the slug, this is likely to happen.
Also, now that the project has been renamed, people with a new interest in the project might instinctively check https://slug-of-new-name.readthedocs.org

I don't have any insight with RTD name change statistics, but I would guess that people don't change the name of a project that often and that, when they do, they have a good reason to do it and don't want the old name to still be associated with the project (think of name change due to copyright infringement too), which is likely to happen if the project still has its old name as RTD slug.
Now I realize this probably doesn't happen often and should probably not be treated as a high-priority issue but I thought it was still worth raising the question.

Maybe making the slug change optional when someone renames a project would be an acceptable solution. Let the user decide if they want to keep that url stable or if they want to change it?

@gregmuellegger gregmuellegger modified the milestones: APIv2.1, AutoAPI Jul 16, 2015
@gregmuellegger gregmuellegger added the Improvement Minor improvement to code label Jul 16, 2015
@gregmuellegger gregmuellegger changed the title Allwo change of project slug Allow change of project slug Sep 17, 2015
@Progi1984
Copy link

I have exactly the problem.

My project : https://github.com/PHPOffice/PHPPowerPoint/ has been renamed to https://github.com/PHPOffice/PHPPresentation

I want the same with docs but impossible. Have you a solution ?

@Progi1984
Copy link

Some news ?

@IanLee1521
Copy link

@Progi1984 I just did this "rename" for pep8 -> pycodestyle today by making a new project with the new name. I need to figure out how to tell people about it now, but at least I have the new url available and I can start publicizing that one instead.

@dojutsu-user
Copy link
Member

Is this issue still open.
I am interested in sending a PR on this.

@humitos
Copy link
Member

humitos commented Jan 22, 2019

@dojutsu-user yes, this issue is marked as Accepted. Feel free to start working on it and sending a PR. Thanks!

@dojutsu-user
Copy link
Member

@humitos
Should we allow the change of slug for a limited number of times, probable only 2-3 times, or for any number of times?

@stsewd
Copy link
Member

stsewd commented Mar 1, 2019

There are still some design decisions here, we were talking about this. And isn't clear how this would affect the commercial site, where we use slugs in a different way.

@humitos
Copy link
Member

humitos commented Mar 4, 2019

For now, this will keep being handled by specific requests and the user won't be able to change the slug by themselves until we make some decisions about it.

@dojutsu-user
Copy link
Member

@humitos
I think this issue can be closed.

@humitos
Copy link
Member

humitos commented Mar 19, 2019

Closing. More info at #5403

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 Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

7 participants