readthedocs.org
readthedocs.org copied to clipboard
Deprecation: stop auto-finding `conf.py`/`mkdocs.yml` from the repository
We currently have code that automatically finds a conf.py on the repository when there is no sphinx.configuration defined ( (https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-configuration). We should remove this auto-finding and make sphinx.configuration to have a better default (like docs/conf.py) or make it always required.
Note: the same happens for
mkdocs.ymlandmkdocs.configuration
https://github.com/readthedocs/readthedocs.org/blob/a23bc260d57a213c33440b02017dcef59fa57a9e/readthedocs/projects/models.py#L944-L962
I created a Metabase query for and I found ~950 projects without specifying sphinx.configuration in the last 180 days.
It might also make sense to first inspect the number of projects that are flagged as spam. This could drop the number of projects considerably too.
I checked that query today and it returned ~400 projects only.
Is that 400 spam projects or 400 projects down from the original 950 projects? The query is stuck for me.
Total projects without filter then from spam
I checked this again today by making the query directly on the Telemetry database because Metabase times out when extending the date range:
SELECT
DISTINCT data->'project'->>'slug' as slug
FROM
"telemetry_builddata"
WHERE
NOT data->'config'->'user'->'sphinx' ? 'configuration'
;
Then, I filtered those slugs by "active" organizations and not spam projects. The results are:
- 22 projects on commercial
- 1202 projects on community
The next steps here are:
- Write a small blog post with specific dates
- Send an email to these users
- Add an
ifin the code to don't auto find these files after the deprecation date - Delete the code that auto find these files
In Q4 we should send some emails out.