提交 5fd80a02 编写于 作者: G Grant Wu 提交者: Matteo Merli

Improve Go/macOS C++ client installation documentation (#2711)

* 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
上级 fe04ce84
...@@ -66,6 +66,10 @@ $ bin/pulsar standalone ...@@ -66,6 +66,10 @@ $ bin/pulsar standalone
Check https://pulsar.apache.org for documentation and examples. Check https://pulsar.apache.org for documentation and examples.
## Build Pulsar docs
Refer to the docs [README](site2/README.md).
## Contact ## Contact
##### Mailing lists ##### Mailing lists
......
...@@ -23,6 +23,8 @@ yarn install ...@@ -23,6 +23,8 @@ yarn install
yarn start 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 ## Contribute
The website is comprised of two parts, one is documentation, while the other is website pages (including blog posts). The website is comprised of two parts, one is documentation, while the other is website pages (including blog posts).
......
...@@ -20,12 +20,10 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o ...@@ -20,12 +20,10 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o
### Installing go package ### 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 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.
>
> `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.
```bash ```bash
$ go get -u github.com/apache/pulsar/pulsar-client-go/pulsar $ go get -u github.com/apache/pulsar/pulsar-client-go/pulsar
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册