Preparation for gofeatures deprecation #801
Conversation
|
The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).
|
| @@ -1,5 +1,8 @@ | |||
| **This is a third-party repository managed by Buf.** | |||
|
|
|||
| This module has been deprecated in favor of `protocolbuffers/wellknowntypes`, which contains the | |||
There was a problem hiding this comment.
This should specifically mention v29.2 -- if a user is using any older version then they can't use wellknowntypes instead.
Do you know if the Markdown rendering library we use in the BSR supports call-outs? If so, that would be nice, to make the deprecation visually obvious even if someone doesn't read all of the text.
In GitHub-flavored Markdown it would look something like so:
>[!WARNING]
> This module has been **deprecated**. As of v29.2, use the `protocolbuffers/wellknowntypes` module instead.With Docusaurus-style callouts, it might look like this instead:
:::warning
This module has been **deprecated**. As of v29.2, use the `protocolbuffers/wellknowntypes` module instead.
:::There was a problem hiding this comment.
This should specifically mention v29.2 -- if a user is using any older version then they can't use wellknowntypes instead.
Sure, I'll say that.
Do you know if the Markdown rendering library we use in the BSR supports call-outs? If so, that would be nice, to make the deprecation visually obvious even if someone doesn't read all of the text.
cc @paul-sachs which one should we use for BSR Readmes?
There was a problem hiding this comment.
I don't think so. We're just using GitHub flavoured markdown and I'm not aware of call-out support within that variant.
There was a problem hiding this comment.
Tried locally, as Paul says I don't think there's a way to do call-outs 😞 so I think just a quote or H2/H3 is good enough? Just sent a change with a quote.
README and CODEOWNERS for future updates of
protocolbuffers/wellknowntypesandprotocolbuffers/gofeaturesstates.You can see individual commits for testing.