-
Notifications
You must be signed in to change notification settings - Fork 247
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
[DOCS] Adds Introduction, Installation, and Connecting sections to Java client docs #13
Conversation
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.
Nice, thanks!
The docs
folder already contains docs/design
that contains internal documentation explaining some design choices. Will this cause issues if we have the public website docs in the parent docs
directory?
Or should we either:
- move public docs one level deeper, e.g.
docs/website
, - or move
docs/design
elsewhere, e.g.design_docs
?
This shouldn't cause any issue as the public-facing docs will be generated based on the |
@swallez Thanks for the feedback, I addressed it. Please have a look at the changes and let me know if I documented the compatibility info correctly. |
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.
LGTM
Gave my LGTM, still waiting for @swallez |
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.
LGTM. Thanks!
Overview
This PR adds an index file, an
Introduction
, anInstallation
, and aConnecting
section to the Java client docs as initial documentation.