readthedocs / blog

Read the Docs blog
https://blog.readthedocs.com
17 stars 56 forks source link

Post: git protocol deprecation on GitHub #152

Closed stsewd closed 2 years ago

stsewd commented 2 years ago

It'd be good to have a closing paragraph at the end of the post, similar to https://blog.readthedocs.com/sphinx-4-4-release-other-ecosystem-news/

Hmm, not really sure what to put there

agjohnson commented 2 years ago

Just realized this might also be a great place to show an example of what the failure looks like. That way anyone search for the failure might be able to find this blog post. Perhaps that's also a way to wrap up the blog post too? Something along "You'll know you are using a git:// URL because you'll see THIS. If you notice any other issues, check our issue tracker or raise a new issue" something something.

stsewd commented 2 years ago

this might also be a great place to show an example of what the failure looks like

I have no idea what the error looks like, but I think it prints a text linking to their blog post and exit. But I'd put that kind of text in the middle of the post, not at the end p:

What about something like:

At Read the Docs we will keep you informed about deprecations or breaking changes from external tools that may impact your builds so you can take action before it happens.

agjohnson commented 2 years ago

I have no idea what the error looks like

Hrm, that's right, I suppose we don't know the error unless we noted it during one of the last brownouts. How about we come back to this on Mar 15 to update with the error message users will be seeing at that point. That way we have an artifact we can point to and users will be able to connect their build error with this blog post hopefully.

We might want some examples of submodules/requirements with git:// at that point as well, but maybe let's see what the increase in build errors actually looks like.