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

Migrate doctype from project to version #6523

Merged
merged 4 commits into from Jan 28, 2020

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Jan 14, 2020

This is related to #4638

We planned to just delete Project.documentation_type, but we realize it was used in another places and it holds some information needed to serve docs like mkdocs or htmldir (#5254, #6102, #6083)

We wanted to remove it because it's limiting us to have only one doctype per project. If a project is created with mkdocs, it can't migrate to sphinx without breaking existing versions.

After this, we can start replacing the usage of version.project.documentation_type for version.documentation_type.

I tested the migration locally, it works as expected. After the migration all versions will start using the value from the config file as doctype.

Copy link
Member

@ericholscher ericholscher left a comment

I think this makes sense, but we likely need to do a bit more messaging and docs around this. We should at least put something in the old admin page where this was set, so that users know that it has been moved.

Copy link
Member

@ericholscher ericholscher left a comment

After talking w/ @stsewd, it sounds like this is a transition step, and we aren't removing the project's doctype yet. I think this makes sense to me then 👍

@stsewd stsewd merged commit 4b0c0e8 into readthedocs:master Jan 28, 2020
2 checks passed
@stsewd stsewd deleted the migrate-doctype-to-version branch Jan 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants