pulsar-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] merlimat closed pull request #2711: Improve Go/macOS C++ client installation documentation
Date Wed, 03 Oct 2018 22:27:39 GMT
merlimat closed pull request #2711: Improve Go/macOS C++ client installation documentation
URL: https://github.com/apache/pulsar/pull/2711
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/README.md b/README.md
index ed7392822a..4311b75c1b 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 fa8c705d9b..19bb4b94ec 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 d9defdc5d2..25d1958a97 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


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message