You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/03/21 03:44:38 UTC
[GitHub] [pulsar] ZiyaoWei opened a new pull request #14766: Remove documentation for the CGo client and call out it has been deprecated
ZiyaoWei opened a new pull request #14766:
URL: https://github.com/apache/pulsar/pull/14766
Fixes #14609
### Motivation
The CGo client has been deprecated since version 2.7.0, but documentation for it is still there.
### Modifications
Remove the documentation for the CGo client, stop referring to it and state that it has been deprecated.
### Verifying this change
- [ ] Make sure that the change passes the CI checks.
This change is a trivial rework / code cleanup without any test coverage.
### Documentation
- [ ] `doc`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #14766: Mark CGo client as deprecated in the documentation
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #14766:
URL: https://github.com/apache/pulsar/pull/14766#discussion_r831791621
##########
File path: site2/docs/client-libraries-cgo.md
##########
@@ -4,6 +4,8 @@ title: Pulsar CGo client
sidebar_label: CGo(deprecated)
---
+> The CGo client has been deprecated since version 2.7.0. If possible, please use the [Go client](client-libraries-go.md) instead.
Review comment:
```suggestion
> The CGo client has been deprecated since version 2.7.0. If possible, use the [Go client](client-libraries-go.md) instead.
```
Do not use please and thank you in technical information. Technical information requires an authoritative tone. Terms of politeness are superfluous, convey the wrong tone for technical material, and are not regarded the same way in all cultures. In marketing information, terms of politeness might be appropriate. Use the imperative mood in the first sentence of each step.
https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#bookmark=id.x24xr2yx9b9t
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #14766: Mark CGo client as deprecated in the documentation
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #14766:
URL: https://github.com/apache/pulsar/pull/14766#issuecomment-1075811614
> @Anonymitaet - done, thanks! Added a banner in the CGo client docs saying it has been deprecated.
Great reminder!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] ZiyaoWei commented on a change in pull request #14766: Mark CGo client as deprecated in the documentation
Posted by GitBox <gi...@apache.org>.
ZiyaoWei commented on a change in pull request #14766:
URL: https://github.com/apache/pulsar/pull/14766#discussion_r832213851
##########
File path: site2/docs/client-libraries-cgo.md
##########
@@ -4,6 +4,8 @@ title: Pulsar CGo client
sidebar_label: CGo(deprecated)
---
+> The CGo client has been deprecated since version 2.7.0. If possible, please use the [Go client](client-libraries-go.md) instead.
Review comment:
Nice doc, thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet merged pull request #14766: Mark CGo client as deprecated in the documentation
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged pull request #14766:
URL: https://github.com/apache/pulsar/pull/14766
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] github-actions[bot] commented on pull request #14766: Remove documentation for the CGo client and call out it has been deprecated
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14766:
URL: https://github.com/apache/pulsar/pull/14766#issuecomment-1073455966
@ZiyaoWei:Thanks for providing doc info!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] github-actions[bot] commented on pull request #14766: Remove documentation for the CGo client and call out it has been deprecated
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14766:
URL: https://github.com/apache/pulsar/pull/14766#issuecomment-1073455913
@ZiyaoWei:Thanks for your contribution. For this PR, do we need to update docs?
(The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] ZiyaoWei commented on pull request #14766: Mark CGo client as deprecated in the documentation
Posted by GitBox <gi...@apache.org>.
ZiyaoWei commented on pull request #14766:
URL: https://github.com/apache/pulsar/pull/14766#issuecomment-1074679852
@Anonymitaet - done, thanks! Added a banner in the CGo client docs saying it has been deprecated.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org