Feature flag: remove DONT_CREATE_INDEX #10471
Conversation
Remove the usage of `DONT_CREATE_INDEX` feature flag that only 1 project is currently using. Besides, this commit removes the auto-creation of the `index.html` file when building with MkDocs or Sphinx. We will be checking at "Uploading" status if there is no `index.html` file and we will fail the build in that case.
Fail the build when there is no `index.html` at its root directory.
readthedocs/projects/tasks/builds.py
Outdated
| "Failing the build. " | ||
| "HTML output does not contain an 'index.html' at its root directory.", | ||
| ) | ||
| raise BuildUserError(BuildUserError.BUILD_OUTPUT_HTML_NO_INDEX_FILE) |
There was a problem hiding this comment.
Is there a way to easily notify users and not fail the build, to start? I feel like we have a pretty good pattern there, if it's easy, and I would like to start doing that any time we remove something that will hard fail a user, to at least give them a heads up with a short duration (eg. 2-4 weeks).
There was a problem hiding this comment.
If we are worried about how many people this will affect, I'd suggest to
- comment this line here
- add a
log.warningto collect projects on NR - wait some weeks
- send those users an email (following the script pattern) and give them 1 month
- uncomment the line again and deploy the changes
What do you say?
There was a problem hiding this comment.
That seems like a good step 👍
Co-authored-by: Eric Holscher <[email protected]>
Only collect data of projects without index.html or README.html at the root. Once we have that data will be contacting those projects to let them know this is deprecated and will make the builds to fail.
…ub.com:readthedocs/readthedocs.org into humitos/feature-flag-dont-create-index-removed
…mitos/feature-flag-dont-create-index-removed
We cannot remove this yet.
|
OK. I change the code to no fail the build for now, but log it on NR. This will help us to contact the users in a few weeks. I add a reminder in Slack for this. At that day, we can write an email and use the script to send the emails. |
Remove the usage of
DONT_CREATE_INDEXfeature flag that only 1 project is currently using.Besides, this commit removes the auto-creation of the
index.htmlfile when building with MkDocs or Sphinx. We will be checking at "Uploading" status if there is noindex.htmlfile and we will fail the build in that case.Now, if there is no
index.htmlat HTML output directory once the build is finished, we fail it and show an error message.Closes #9290
📚 Documentation previews 📚
docs): https://docs--10471.org.readthedocs.build/en/10471/dev): https://dev--10471.org.readthedocs.build/en/10471/