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

Build: remove support for MkDocs <= 0.17.3 #10584

Merged
merged 2 commits into from
Sep 26, 2023

Conversation

humitos
Copy link
Member

@humitos humitos commented Jul 31, 2023

We want to keep deprecating old feature flags we don't want to support forever. In particular, those that keep our users using pretty old versions of doctools and freeze them in a status that's hard to maintain.

This PR removes the DEFATUL_TO_MKDOCS_0_17_3 feature flag and always install the latest mkdocs version. Note this feature flag has default_true=True for those projects created before 2019-04-03.

I did a small DB query and found:

>>> Project.objects.filter(pub_date__lt=timezone.datetime(2019, 4, 3), documentation_type='mkdocs').count()
7529

However, note we don't know if these projects are pinning a version of MkDocs, so we don't exactly know how many of those are using this feature. However, it gives us a maximum number at least.

On the other hand, taking a look at Metabase, using the build data from the past 6 months I found that we only have 293 projects:
https://ethicalads.metabaseapp.com/question/218-projects-using-mkdocs-group-by-version

We need to merge this PR between 📅 September 27th and October 2nd so it's deployed on October 3rd 📅

Related #9779

We want to keep deprecating old feature flags we don't want to support forever.
In particular, those that keep our users using pretty old versions of doctools
and freeze them in a status that's hard to maintain.

This PR removes the `DEFATUL_TO_MKDOCS_0_17_3` feature flag and always install
the latest `mkdocs` version. Note this feature flag has `default_true=True` for
those projects created _before 2019-04-03_.

I did a small DB query and found:

```python
>>> Project.objects.filter(pub_date__lt=timezone.datetime(2019, 4, 3),
documentation_type='mkdocs').count()
7529
```

However, note we don't know if these projects are pinning a version of MkDocs,
so we don't exactly know how many of those are using this feature. However, it
gives us a maximum number at least.

On the other hand, taking a look at Metabase, using the build data from the past
6 months I found that we only have 293 projects:
https://ethicalads.metabaseapp.com/question/218-projects-using-mkdocs-group-by-version

Related #9779
@humitos humitos added the Status: blocked Issue is blocked on another issue label Jul 31, 2023
@humitos humitos requested a review from a team as a code owner July 31, 2023 10:26
@humitos humitos requested a review from stsewd July 31, 2023 10:26
humitos added a commit to readthedocs/blog that referenced this pull request Aug 1, 2023
@humitos humitos requested review from ericholscher and removed request for stsewd August 1, 2023 10:27
@humitos
Copy link
Member Author

humitos commented Aug 1, 2023

We need to merge this PR between 📅 September 27th and October 2nd so it's deployed on October 3rd 📅

@humitos
Copy link
Member Author

humitos commented Aug 2, 2023

Today, we emailed our users about this.

@humitos humitos removed the Status: blocked Issue is blocked on another issue label Sep 26, 2023
@humitos
Copy link
Member Author

humitos commented Sep 26, 2023

@stsewd @ericholscher this is review for review and merge. We should merge it before deploying next week due to https://blog.readthedocs.com/defaulting-latest-build-tools/

@humitos humitos enabled auto-merge (squash) September 26, 2023 16:41
@humitos humitos merged commit 7bc5c76 into main Sep 26, 2023
2 checks passed
@humitos humitos deleted the humitos/remove-support-mkdoc-0.17 branch September 26, 2023 16:48
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.

2 participants