|
| 1 | +title: Deprecation: Removal of redirect for root documentation URL to "README.html" |
| 2 | +date: 2024-05-27 |
| 3 | +category: Changelog |
| 4 | +tags: hosting, deprecation |
| 5 | +authors: Manuel Kaufmann |
| 6 | +status: published |
| 7 | +image: /images/readme-html-deprecated.jpg |
| 8 | +image_credit: Photo by <a href="https://unsplash.com/@introspectivedsgn?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Erik Mclean</a> on <a href="https://unsplash.com/photos/black-asus-laptop-computer-showing-3-00-sxiSod0tyYQ?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a> |
| 9 | + |
| 10 | +We are announcing the **deprecation of redirecting root URLs (`/`) to `/README.html`** |
| 11 | +for all the projects that don't output an `index.html` file when building the documentation. |
| 12 | +The deprecation date is set on **Monday, July 1st, 2024**. |
| 13 | +After this date, projects not outputting an `index.html` file will [fail their builds](https://blog.readthedocs.com/builds-without-index/). |
| 14 | + |
| 15 | +### Deprecation timeline |
| 16 | + |
| 17 | +We understand this change will affect a few hundred of projects, so we have a timeline to communicate this deprecation to our users effectively. |
| 18 | + |
| 19 | +* **Tuesday, May 28, 2024**: Email project owners using this deprecated feature so they can take action. |
| 20 | +* **Monday, June 10, 2024**: Do the first brownout (temporarily enforce this deprecation) for 12 hours: 00:01 PST to 11:59 PST (noon) |
| 21 | +* **Monday, June 17, 2024**: Do a second brownout (temporarily enforce this deprecation) for 24 hours: 00:01 PST to 23:59 PST (midnight) |
| 22 | +* **Monday, June 24, 2024**: Do a third and final brownout (temporarily enforce this deprecation) for 48 hours: 00:01 PST to 23:59 PST (midnight) |
| 23 | +* **Monday, July 1, 2024**: Fully remove support for building documentation without configuration file v2. |
| 24 | + |
| 25 | +We strongly recommend to update your projects before July 1st, 2024 to avoid any downtime. |
| 26 | + |
| 27 | +### How to update your project |
| 28 | + |
| 29 | +There are different approaches that can be followed depending on the configuration of your project. |
| 30 | + |
| 31 | +1. Migrate your Sphinx documentation to use `master_doc = "index"` instead of `master_doc = "README"`. |
| 32 | + This can be done by re-structuring your documentation or by creating a symlink from of `index.rst -> README.rst`. |
| 33 | +2. Rename the `README.html` as `index.html` once the build has finished using [`build.jobs.post_build`](https://docs.readthedocs.io/en/stable/config-file/v2.html#build-jobs) |
| 34 | + |
| 35 | +Note these are only two possible ideas, but there may be other ways to achieve the same goal. |
| 36 | + |
| 37 | +> _**Tip**: you can create a redirect from `/README.html` to `/` to keep links pointing to the deprecated URL working._ |
| 38 | +
|
| 39 | +[Contact us](https://readthedocs.org/support/) if you have any questions, |
| 40 | +and let us know any inconvenient you may have with this change. |
0 commit comments