pulsar-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mme...@apache.org
Subject [pulsar] branch master updated: Improve Go/macOS C++ client installation documentation (#2711)
Date Wed, 03 Oct 2018 22:27:42 GMT
This is an automated email from the ASF dual-hosted git repository.

mmerli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 5fd80a0  Improve Go/macOS C++ client installation documentation (#2711)
5fd80a0 is described below

commit 5fd80a027f10695f76dd403560050a28953bfd36
Author: Grant Wu <grantwwu@gmail.com>
AuthorDate: Wed Oct 3 18:27:37 2018 -0400

    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
---
 README.md                         | 4 ++++
 site2/README.md                   | 2 ++
 site2/docs/client-libraries-go.md | 8 +++-----
 3 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index ed73928..4311b75 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/site2/README.md b/site2/README.md
index fa8c705..19bb4b9 100644
--- a/site2/README.md
+++ b/site2/README.md
@@ -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).
diff --git a/site2/docs/client-libraries-go.md b/site2/docs/client-libraries-go.md
index d9defdc..25d1958 100644
--- a/site2/docs/client-libraries-go.md
+++ b/site2/docs/client-libraries-go.md
@@ -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


Mime
View raw message