Skip to content
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

Merged
merged 8 commits into from
Sep 13, 2021

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Sep 10, 2021

Overview

This PR adds an index file, an Introduction, an Installation, and a Connecting section to the Java client docs as initial documentation.

@szabosteve szabosteve changed the title [DOCS] Adds Introduction and Installation section to Java client docs [DOCS] Adds Introduction and Installation sections to Java client docs Sep 10, 2021
@szabosteve szabosteve changed the title [DOCS] Adds Introduction and Installation sections to Java client docs [DOCS] Adds Introduction, Installation, and Connecting sections to Java client docs Sep 10, 2021
@szabosteve szabosteve requested a review from swallez September 10, 2021 11:42
@szabosteve szabosteve added 7.x v8.0.0 Area: Documentation Improvements or additions to documentation labels Sep 10, 2021
Copy link
Member

@swallez swallez left a 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?

docs/installation.asciidoc Outdated Show resolved Hide resolved
@szabosteve
Copy link
Contributor Author

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?

This shouldn't cause any issue as the public-facing docs will be generated based on the index.asciidoc file which won't contain any reference to the internal docs files. From this perspective, it's not necessary to move the files around/change the folder structure.

@szabosteve szabosteve requested a review from swallez September 13, 2021 12:05
@szabosteve
Copy link
Contributor Author

@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.

Copy link
Contributor

@philkra philkra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@philkra
Copy link
Contributor

philkra commented Sep 13, 2021

Gave my LGTM, still waiting for @swallez

Copy link
Member

@swallez swallez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@szabosteve szabosteve merged commit 6c9774c into elastic:main Sep 13, 2021
@szabosteve szabosteve deleted the initial.docs branch September 13, 2021 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants