-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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] Simplify the Install section and promote a top-level "Installation" title #17580
[improve][doc] Simplify the Install section and promote a top-level "Installation" title #17580
Conversation
Signed-off-by: tison <[email protected]>
Signed-off-by: tison <[email protected]>
Signed-off-by: tison <[email protected]>
Signed-off-by: tison <[email protected]>
Co-authored-by: Anonymitaet <[email protected]> Co-authored-by: Matteo Merli <[email protected]>
@merlimat @Anonymitaet Thanks for your reviews! Comments addressed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a concern that should we just link to https://github.com/apache/pulsar/tree/master/pulsar-client-cpp#compilation instead of adding repeated documents here?
Building C++ client from source is usually not easy for users other than experienced C++ developers. The content is a little complicated for basic users. They need to know:
- The dependencies
- How to install them
- The requirements of the C++ compiler and CMake
And the details are all covered by https://github.com/apache/pulsar/tree/master/pulsar-client-cpp#readme
For example, I see you added -DBUILD_TESTS=OFF
options. However, it's already covered in here, from which you can see other options like using DBUILD_PYTHON_WRAPPER=OFF
to skip building python client.
Showing a simplified document might make those C++ users (not deep developers) confused and they might ask why cannot they build successfully after following the guide in the official website.
I agree that build from source has low frequency and users who want to do it will be OK to jump to the source code repository. Will push a commit tomorrow. Also, cc @merlimat @RobertIndie @shibd for inputs. |
Signed-off-by: tison <[email protected]>
ecf6550
to
b6df2f9
Compare
Signed-off-by: tison <[email protected]>
@shibd @Demogorgon314 updated. Here is the preview: |
@BewareMyPower @Demogorgon314 @RobertIndie It seems we reached a consensus here. Could you help with merging this PR? |
…Installation" title (apache#17580)
Fixes #17385
Documentation
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)