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

Post: redirecting / to README.html deprecation #287

Merged
merged 5 commits into from
May 27, 2024

Conversation

humitos
Copy link
Member

@humitos humitos commented May 23, 2024

@humitos humitos requested a review from a team as a code owner May 23, 2024 16:25
@humitos humitos requested a review from ericholscher May 23, 2024 16:25
image: /images/readme-html-deprecated.jpg
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>

We are announcing the **deprecation of redirecting root URLs (`/`) to `/README.html`**
Copy link
Member

Choose a reason for hiding this comment

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

Is this what we're doing? I thought we were serving README.html as the index at /?

Copy link
Member Author

Choose a reason for hiding this comment

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

I thought the same, and I found I was wrong while writing the blog post:

▶ curl -I https://pytest-bootstrap.readthedocs.io/en/latest/   
HTTP/2 302 
date: Fri, 24 May 2024 15:27:52 GMT
...
location: /en/latest/README.html

Maybe we change this over the years?

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, it seems that it redirects all the index URLs (?), not just root. See santos' comment in readthedocs/readthedocs.org#11348 (comment)

Copy link
Member

Choose a reason for hiding this comment

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

yep, this applies to all index pages.

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you have a suggestion for a better wording here?

Copy link
Member

Choose a reason for hiding this comment

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

just use index instead of root 🤔

content/posts/readme-html-deprecated.md Outdated Show resolved Hide resolved
content/posts/readme-html-deprecated.md Outdated Show resolved Hide resolved
@humitos humitos merged commit 229bbf2 into main May 27, 2024
4 checks passed
@humitos humitos deleted the humitos/readme-html-deprecation branch May 27, 2024 15:11
humitos added a commit that referenced this pull request May 28, 2024
ericholscher pushed a commit that referenced this pull request May 28, 2024
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