Post: deprecation of building without config file #219
Conversation
Initial blog post to point users to when talking about the deprecation of "building without a configuration file". I'm not mentioning a specific date on purpose here because we don't know yet. However, I'm mentioning Sept 2023 because our goal is to match with the drop of OpenSSL 1.1.1 support on `urllib`. We can update the post once we know this exact date and also write a new pretty small blog post with an update of the exact date later if we want to, but may not be necessary tho. Once this blog post is published, we can update some links in the application to point users to this post also. Note that I wrote a "suggested configuration file" and alos describe some of the differences, so users can dig a little more in case they start getting some errors. I don't want to give them just a blob of YAML without guiding the a little in the process.
|
I tested my suggested configuration file works at https://readthedocs.org/projects/test-builds/builds/20852204/ |
There was a problem hiding this comment.
This proposal is great 💯 Deprecation notice, September 2023 deadline, give people a simple example and a solid checklist about how it might be customized 👍
All my comments here are about optimizing the blog post's content and making the information clearer.
I'm happy to give a second review quickly.
I think this should go out BEFORE the June newsletter and BEFORE the deprecation notification are added in builds (because then the deprecation warning can link to this blog post!)
This blog post can be the main message in the June newsletter, which makes the newsletter more important and gives the blog post added exposure.
|
@benjaoming Thanks for the review 👍🏼. I took some suggestions that I found good and easy to apply. In particular, the addition of sections and the expansion of the dashboard settings since they have to be migrated as well. That was a good point that I missed 💯 |
|
OK. I will move forward with this PR and merge it so it's published and I can continue with the deprecation emails and notifications. I'm happy to come back to this blog post and update it as needed once people start reading it and having doubts/questions/things that are not clear. |
Co-authored-by: Anthony <[email protected]>
Initial blog post to point users to when talking about the deprecation of "building without a configuration file".
I'm not mentioning a specific date on purpose here because we don't know yet. However, I'm mentioning Sept 2023 because our goal is to match with the drop of OpenSSL 1.1.1 support on
urllib. We can update the post once we know this exact date and also write a new pretty small blog post with an update of the exact date later if we want to, but may not be necessary tho.Once this blog post is published, we can update some links in the application to point users to this post also.
Note that I wrote a "suggested configuration file" and alos describe some of the differences, so users can dig a little more in case they start getting some errors. I don't want to give them just a blob of YAML without guiding the a little in the process.
📚 Rendered version 📚 : https://readthedocs-blog--219.org.readthedocs.build/migrate-configuration-v2/
Related readthedocs/readthedocs.org#10351