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.

Sign up for GitHub

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

Jump to bottom

Deprecations: list of all past and ongoing deprecations #10587

Open
humitos opened this issue Aug 1, 2023 · 4 comments
Open

Deprecations: list of all past and ongoing deprecations #10587

humitos opened this issue Aug 1, 2023 · 4 comments
Assignees
@humitos
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code

Comments

@humitos
Copy link
Member

humitos commented Aug 1, 2023 •
edited
Loading

We have been deprecating pretty old non-used or broken features in the last weeks and we found ourselves a little lost about the big picture (whole plan) but also about what are the features that are going through the deprecation time. This issue just list them all here with the exact dates when they are making effective:

Feature Email (dates) Removal (dates) Affected projects
#10514: Drop PyPy support Not sent July 18th 0
#10550: Fail builds without index.html July 19th August 1st ~114
#10508: Install latest version of requirements July 10th August 7th New projects
#10494: Remove UPDATE_CONDA_STARTUP Jun 29th August 28th 13
#10588: Remove DONT_SHALLOW_CLONE June 26th August 28th 61
#5609: Doctools without config file July 11th August 28th 1.8k
#10562: Remove python.system_packages August 7th August 29th ~8k
#10367: No .readthedocs.yaml and v1 Weekly (starting May 31th) September 25th All projects
#10584: Drop support for MkDocs 0.17.3 August 2nd October 3rd 293
#10365: Drop support for Sphinx 1.x Aug 23th October 3rd ~8k
#10589: Drop build.image Weekly October 16th ~16k
#8840: Drop VCS (svn, hg, bzr) March 20th June 3rd ~6k
#11206: Drop MKDOCS_THEME_RTD feature flag Undefined April 15th ~2
#9993: Don't serve README.html at / May 28th July 1st ~250
#11441: Don't auto-inject Sphinx context/configs Soon July 29th & Oct 7th All Sphinx projects
#9530: Auto-injection of Google Analytics Undefined Oct 7th ~5k
#8659: Deprecate setup.py install Undefined Undefined ~350
#10677: Embed APIv2 removal Jan 20th ~30
#10637: Stop finding conf.py and mkdocs.yml Undefined Undefined ~950
#11037: Old incoming webhooks Undefined Undefined N/A
#11839: APIv2 Undefined Undefined N/A

Related: #9779

Note: the table is sort by ascending "Removal (dates)"
@humitos humitos added Improvement Minor improvement to code Accepted Accepted issue on our roadmap labels Aug 1, 2023
@humitos humitos self-assigned this Aug 1, 2023
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Aug 1, 2023
@humitos humitos mentioned this issue Aug 1, 2023
Merged
@humitos humitos moved this from Planned to In progress in 📍Roadmap Aug 1, 2023
humitos added a commit that referenced this issue Aug 1, 2023
@humitos
Deprecation: notification and feature flag for build.image config
8227721 
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 humitos mentioned this issue Aug 1, 2023
Merged
@ericholscher
Copy link
Member

This looks good. I might align the Sphinx 1.8 & Mkdocs .17 dates, since they seem like basically the same deprecation (eg. removing old default build tools).

humitos added a commit that referenced this issue Aug 3, 2023
@humitos
Deprecation: notification and feature flag for build.image config
b1810c3 
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
@gavinevans gavinevans mentioned this issue Aug 8, 2023
Merged
1 task
humitos added a commit that referenced this issue Aug 9, 2023
@humitos @agjohnson @ericholscher
Deprecation: notification and feature flag for build.image config (#…
fdf6b60 
…10589)

* Deprecation: notification and feature flag for `build.image` config

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

* Deprecation: notification and feature flag for `build.image` config

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

* Review and update logic

* Start emailing people with projects building from 3 years ago

* Apply suggestions from code review

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

* Add HTML version of the email

* Codify brownout dates and remove the feature flag

Follows the suggestion from https://github.com/readthedocs/blog/pull/233/files#r1283479184

* Use UTC datetimes to compare

* Contact projects with a build in the last 3 years

We will start with 3 years timeframe first and then lower it down to 1 year.

---------

Co-authored-by: Anthony <[email protected]>
Co-authored-by: Eric Holscher <[email protected]>
humitos added a commit that referenced this issue Aug 9, 2023
@humitos @agjohnson @ericholscher
Deprecation: codify browndates for "no config file deprecation" (#10612)
18889f0 
* Deprecation: notification and feature flag for `build.image` config

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

* Deprecation: notification and feature flag for `build.image` config

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

* Review and update logic

* Start emailing people with projects building from 3 years ago

* Apply suggestions from code review

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

* Add HTML version of the email

* Codify brownout dates and remove the feature flag

Follows the suggestion from https://github.com/readthedocs/blog/pull/233/files#r1283479184

* Use UTC datetimes to compare

* Deprecation: codify browndates for "no config file deprecation"

Follows https://github.com/readthedocs/blog/pull/233/files#r1283479184

This way, we don't have to enable anything manually.
These dates are already communicated to users and will be automatically applied.

---------

Co-authored-by: Anthony <[email protected]>
Co-authored-by: Eric Holscher <[email protected]>
@humitos humitos pinned this issue Aug 16, 2023
@ericholscher ericholscher mentioned this issue Aug 16, 2023
Closed
@humitos humitos mentioned this issue Sep 4, 2023
Merged
@parona-source parona-source mentioned this issue Nov 1, 2023
Open
2 tasks
@stsewd
Copy link
Member

stsewd commented Nov 14, 2023

We are deprecating webhooks created without a secret on January 31st, 2024.

https://blog.readthedocs.com/security-update-on-incoming-webhooks/

@thephez thephez mentioned this issue Feb 5, 2024
Closed
6 tasks
@ericholscher ericholscher mentioned this issue Mar 19, 2024
Merged
@MoltonMontro MoltonMontro mentioned this issue Jul 17, 2024
Merged
@thephez
Copy link

thephez commented Nov 19, 2024

Looks like #9530 has taken affect (status not updated here)? Just noticed traffic fell off a cliff recently.

@stsewd
Copy link
Member

stsewd commented Nov 25, 2024

We are deprecating embed api v2, you probably are using it through our sphinx-hoverxref extension, if so, make sure you are using the latest version.

https://about.readthedocs.com/blog/2024/11/embed-api-v2-deprecated/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@humitos humitos

Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@ericholscher @humitos @stsewd @thephez and others