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

Fix README to better reflect reality #172

Merged
merged 4 commits into from
Jun 10, 2021
Merged

Fix README to better reflect reality #172

merged 4 commits into from
Jun 10, 2021

Conversation

astrojuanlu
Copy link
Contributor

@astrojuanlu astrojuanlu commented Jun 9, 2021

Even though we updated the README in #137, we never updated the actual images on the service:

https://github.com/readthedocs/readthedocs.org/blob/75955e153d8a6e56d001008b6b3855455b5abeb0/readthedocs/settings/base.py#L501-L506

Also, as @humitos mentioned in #170 (review) and other places, we don't intend to update these images anymore until we implement the new ones. (Edit: I toned this down, see reviews)

And finally, on #159 we added support for Python 3.9 in our testing image, but we didn't update the README to reflect that.

Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

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

Good to have the doc better reflect reality, however that also means that we currently only have a loose plan to change these images at some point in the future. This work is not currently on our near/middle term roadmap because it's a high effort and probably fairly low value outside operations improvements.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@astrojuanlu astrojuanlu requested review from agjohnson and a team June 9, 2021 20:32
@astrojuanlu astrojuanlu changed the title Fix README, mention freeze of current images Fix README to better reflect reality Jun 9, 2021
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.

Reality FTW 👍

@astrojuanlu astrojuanlu merged commit 1ebe82a into master Jun 10, 2021
@astrojuanlu astrojuanlu deleted the fix-readme branch June 10, 2021 17:43
@astrojuanlu astrojuanlu mentioned this pull request Sep 16, 2021
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.

4 participants