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: "Builds with no index.html file" #230

Merged
merged 4 commits into from
Jul 25, 2023
Merged

Conversation

humitos
Copy link
Member

@humitos humitos commented Jul 19, 2023

Minimal changelog post announcing readthedocs/readthedocs.org#1800

Currently, we are logging this projects, but on August 1st we will be failing builds that do not generate an index.html on the output's directory.

Minimal changelog post announcing readthedocs/readthedocs.org#1800

Currently, we are logging this projects, but on August 1st we will be failing
builds that do not generate an `index.html` on the output's directory.
@humitos humitos requested a review from a team as a code owner July 19, 2023 11:15
humitos added a commit to readthedocs/readthedocs.org that referenced this pull request Jul 19, 2023
We announced we deprecated this in readthedocs/blog#230
and we already contacted the users to warn about this.

This PR has to be merged after July 25th, 2023 and it has to be deployed on
August 1st.

Closes #1800
@ericholscher
Copy link
Member

@humitos I thought we discussed not posting this to the blog, since it's emailing folks?

@humitos
Copy link
Member Author

humitos commented Jul 24, 2023

I'm not opposed to communicate platform changes to our users. I think it's something good, in fact. The amount of emails we send to users it's pretty low anyways, so I'm fine keeping this pattern 👍🏼

In the future we can create different groups people can (un)subscribe as they want, but I don't think we have to solve that problem yet.

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Seems reasonable 👍

builds-without-index.rst Outdated Show resolved Hide resolved
@humitos humitos merged commit a05e582 into main Jul 25, 2023
@humitos humitos deleted the humitos/builds-without-index branch July 25, 2023 08:46
humitos added a commit to readthedocs/readthedocs.org that referenced this pull request Jul 26, 2023
)

* Build: fail builds if there is no `index.html` in the output dir

We announced we deprecated this in readthedocs/blog#230
and we already contacted the users to warn about this.

This PR has to be merged after July 25th, 2023 and it has to be deployed on
August 1st.

Closes #1800

* Test: create an "index.html" to run build successfully

---------

Co-authored-by: Eric Holscher <[email protected]>
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