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

[improve][doc] Improve golang client doc #17455

Merged
merged 23 commits into from
Sep 7, 2022

Conversation

labuladong
Copy link
Contributor

Fixes #17397

Motivation

Fix some errors in the Golang doc and improve code demos.

Modifications

Update some out-of-date API interfaces and make all code snippets can run.

Documentation

Check the box below or label this PR directly.

Need to update docs?

  • doc-required
    (Your PR needs to update docs and you will update later)

  • doc-not-needed
    (Please explain why)

  • doc
    (Your PR contains doc changes)

  • doc-complete
    (Docs have been already added)

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Sep 4, 2022
@tisonkun
Copy link
Member

tisonkun commented Sep 4, 2022

Comment for a cross-reference to #17302.

@labuladong labuladong changed the title WIP: improve golang doc [improve][doc] Improve golang client doc Sep 5, 2022
@labuladong labuladong marked this pull request as ready for review September 5, 2022 03:48
@labuladong
Copy link
Contributor Author

cc @Anonymitaet @momo-jun

Copy link
Member

@nodece nodece left a comment

Choose a reason for hiding this comment

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

Overall this PR looks good to me, I noticed we added some configurable parameters on this page.

I suggest link to https://pkg.go.dev/github.com/apache/pulsar-client-go/pulsar

@labuladong
Copy link
Contributor Author

Thanks for your suggestion. Links added. @nodece

@labuladong labuladong requested a review from nodece September 5, 2022 08:59
@Anonymitaet Anonymitaet added this to the 2.12.0 milestone Sep 6, 2022
@labuladong
Copy link
Contributor Author

I've removed the partition subscription example 1aeac82 and replaced all configuration with link 6298411.

PTAL @nodece @Anonymitaet @RobertIndie

site2/docs/client-libraries-go.md Outdated Show resolved Hide resolved
site2/docs/client-libraries-go.md Outdated Show resolved Hide resolved
site2/docs/client-libraries-go.md Outdated Show resolved Hide resolved
@Anonymitaet
Copy link
Member

Thanks for your contribution! Have you previewed your changes to ensure everything goes as expected?

If not yet, please preview your changes locally and attach the screenshots in the PR description to let others know. In this way, you can get your PR merged more quickly. Thanks!

@labuladong
Copy link
Contributor Author

Screenshots of this PR:

FireShot Capture 003 - Pulsar Go client - Apache Pulsar - localhost

PTAL @Anonymitaet

@Anonymitaet
Copy link
Member

@labuladong thanks! Feel free to ping me to merge this PR after all tests pass.

@labuladong
Copy link
Contributor Author

ping @Anonymitaet

@Anonymitaet Anonymitaet merged commit 757035b into apache:master Sep 7, 2022
@momo-jun momo-jun modified the milestones: 2.12.0, 2.11.0 Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc][Go] Fix mistakes and improve code snippet of golang client document
7 participants