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

Deprecation: notification and feature flag for build.image config #10589

Merged
merged 11 commits into from
Aug 9, 2023

Conversation

humitos
Copy link
Member

@humitos humitos commented Aug 1, 2023

Define a weekly task to communicate our users about the deprecation of build.image (or not specifying build.os) using the deprecation plan we used for the configuration file v2 as well.

  • 3 brownout days
  • final removal date on October 16th
  • weekly onsite/email notification on Wednesday at 11:15 CEST (around ~16k projects affected)
  • allow to opt-out from these emails
  • feature flag for brownout days
  • build detail's page notification

Related:

Closes:

Define a weekly task to communicate our users about the deprecation of
`build.image` using the deprecation plan we used for the configuration file v2
as well.

- 3 brownout days
- final removal date on October 2nd
- weekly onsite/email notification on Wednesday at 11:15 CEST (around 3.5k projects affected)
- allow to opt-out from these emails
- feature flag for brownout days
- build detail's page notification

Related:
* readthedocs/meta#48
* #10354
* #10587
humitos added 5 commits August 3, 2023 13:33
Define a weekly task to communicate our users about the deprecation of
`build.image` using the deprecation plan we used for the configuration file v2
as well.

- 3 brownout days
- final removal date on October 2nd
- weekly onsite/email notification on Wednesday at 11:15 CEST (around ~22k projects affected)
- allow to opt-out from these emails
- feature flag for brownout days
- build detail's page notification

Related:
* readthedocs/meta#48
* #10354
* #10587
…:readthedocs/readthedocs.org into humitos/deprecate-build-image-config-key
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

This looks good to me, and similar to our other approach. A few questions, but I think it's close.

readthedocs/core/models.py Outdated Show resolved Hide resolved
readthedocs/doc_builder/exceptions.py Outdated Show resolved Hide resolved
readthedocs/doc_builder/exceptions.py Outdated Show resolved Hide resolved
readthedocs/projects/tasks/utils.py Show resolved Hide resolved
readthedocs/projects/tasks/utils.py Show resolved Hide resolved
Co-authored-by: Anthony <[email protected]>
Co-authored-by: Eric Holscher <[email protected]>
@humitos
Copy link
Member Author

humitos commented Aug 8, 2023

I applied all the suggestions. I will update the HTML email and we will be ready to approve and merge, I guess.

@humitos humitos requested a review from ericholscher August 8, 2023 15:33
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Looks good to me. I'm fine emailing more folks at first, then dropping it down, we should just make sure the email content matches the actual timeframe used 👍

humitos added a commit to readthedocs/blog that referenced this pull request Aug 9, 2023
* Post: Use `build.os` instead of `build.image`

Announcement for readthedocs/readthedocs.org#10589

* Apply suggestions from code review

Co-authored-by: Eric Holscher <[email protected]>

* Update date

---------

Co-authored-by: Eric Holscher <[email protected]>
We will start with 3 years timeframe first and then lower it down to 1 year.
@humitos humitos enabled auto-merge (squash) August 9, 2023 08:34
@humitos humitos merged commit fdf6b60 into main Aug 9, 2023
@humitos humitos deleted the humitos/deprecate-build-image-config-key branch August 9, 2023 08:49
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.

3 participants