Skip to content

Commit

Permalink
Improve Go/macOS C++ client installation documentation (apache#2711)
Browse files Browse the repository at this point in the history
* Clarify version match requirements between Go and C++ client librarires

* Document how to see local changes

* Link to docs README

* Move warning out from `go get` paragraph
  • Loading branch information
grantwwu authored and merlimat committed Oct 3, 2018
1 parent fe04ce8 commit 5fd80a0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ $ bin/pulsar standalone

Check https://pulsar.apache.org for documentation and examples.

## Build Pulsar docs

Refer to the docs [README](site2/README.md).

## Contact

##### Mailing lists
Expand Down
2 changes: 2 additions & 0 deletions site2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ yarn install
yarn start
```

Note that the `/docs/en/` path shows the documentation for the latest stable release of Pulsar. Change it to `/docs/en/next/` to show your local changes, with live refresh.

## Contribute

The website is comprised of two parts, one is documentation, while the other is website pages (including blog posts).
Expand Down
8 changes: 3 additions & 5 deletions site2/docs/client-libraries-go.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,10 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o

### Installing go package

You can install the `pulsar` library locally using `go get`:
> #### Compatibility Warning
> The version number of the Go client **must match** the version number of the Pulsar C++ client library.
> #### NOTE
>
> `go get` doesn't support fetching a specific tag. so it will always pull in pulsar go client
> from latest master. You need to make sure you have installed the right pulsar cpp client library.
You can install the `pulsar` library locally using `go get`. Note that `go get` doesn't support fetching a specific tag - it will always pull in master's version of the Go client. You'll need a C++ client library that matches master.

```bash
$ go get -u github.com/apache/pulsar/pulsar-client-go/pulsar
Expand Down

0 comments on commit 5fd80a0

Please sign in to comment.