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

Proxito: browndate for redirecting / to README.html #11348

Merged
merged 7 commits into from
May 29, 2024

Conversation

humitos
Copy link
Member

@humitos humitos commented May 23, 2024

Related #9993

@humitos humitos requested a review from a team as a code owner May 23, 2024 16:50
@humitos humitos requested a review from stsewd May 23, 2024 16:50
Comment on lines 207 to 212
if allow_readme_html_at_root_url():
tryfiles = ["index.html", "README.html"]
else:
tryfiles = ["index.html"]

if relpath == "404.html" or filename in tryfiles:
Copy link
Member

Choose a reason for hiding this comment

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

We should still keep tracking README.html files here. Otherwise, after a brown out is done, users will need to re-build their docs in order to have them serve a README file as index again.

Copy link
Member Author

@humitos humitos May 24, 2024

Choose a reason for hiding this comment

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

I don't understand your comment. We don't want README files being served as index after the brownout dates. Can you expand on this?

Copy link
Member

Choose a reason for hiding this comment

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

We don't want to serve them on the brown out dates, but after one brown out is done (next day), we want to continue serving them. You are already doing that check at serve time, you don't need to remove the indexing of README files, that will make our serve code to not be aware of README files after a brown out is finished.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in df3df02

readthedocs/proxito/views/utils.py Outdated Show resolved Hide resolved
@humitos humitos requested a review from stsewd May 28, 2024 15:56
@humitos humitos merged commit 77d4a97 into main May 29, 2024
7 checks passed
@humitos humitos deleted the humitos/readme-html-browndates branch May 29, 2024 09:42
humitos added a commit that referenced this pull request Jul 1, 2024
humitos added a commit that referenced this pull request Jul 11, 2024
* Proxito: remove redirect for `README.html` files

Fully removal after deprecation and browndates.

Reference:
* #9993
* #11348
* https://about.readthedocs.com/blog/2024/05/readme-html-deprecated/

* Simplify the logic for tryfiles on El Proxito

* Add missing case

* Remove README from the docstring
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