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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Adds getting started content based on the template #617

Merged
merged 3 commits into from
Jul 6, 2023
Merged

[DOCS] Adds getting started content based on the template #617

merged 3 commits into from
Jul 6, 2023

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Jul 3, 2023 •
edited by swallez
Loading

Overview

This PR adds a getting started page to the Java client documentation. The content is based on the client getting started template.

As the Java client has a "Getting started" aggregation page, this PR renames it to "Setup", so the new page can be called "Getting started" which ensures consistency across the Client books.

For the reviewer co-author

Please provide content/example code for the following sections:

  • Requirements
  • Installation
  • Connecting
  • Creating an index
  • Indexing documents
  • Getting documents
  • Searching documents
  • Updating documents
  • Deleting documents
  • Deleting an index

Preview

Getting started

@szabosteve szabosteve requested a review from swallez July 3, 2023 09:38
@szabosteve szabosteve added Area: Documentation Improvements or additions to documentation backport 8.8 backport 8.9 labels Jul 3, 2023
swallez
swallez approved these changes Jul 6, 2023
View reviewed changes
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!

@szabosteve szabosteve merged commit 7976e22 into main Jul 6, 2023
@szabosteve szabosteve deleted the szabosteve/getting-started branch July 6, 2023 16:10
github-actions bot pushed a commit that referenced this pull request Jul 6, 2023
@szabosteve @swallez @github-actions
[DOCS] Adds getting started content based on the template (#617)
877c3c2 
Co-authored-by: Sylvain Wallez <sylvain@elastic.co>
@github-actions github-actions bot mentioned this pull request Jul 6, 2023
Merged
github-actions bot pushed a commit that referenced this pull request Jul 6, 2023
@szabosteve @swallez @github-actions
[DOCS] Adds getting started content based on the template (#617)
844e540 
Co-authored-by: Sylvain Wallez <sylvain@elastic.co>
@github-actions github-actions bot mentioned this pull request Jul 6, 2023
Merged
swallez added a commit that referenced this pull request Jul 6, 2023
@github-actions @szabosteve @swallez
[DOCS] Adds getting started content based on the template (#617) (#622)
ac905b3 
Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
Co-authored-by: Sylvain Wallez <sylvain@elastic.co>
@szabosteve szabosteve mentioned this pull request Jul 7, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@swallez swallez swallez approved these changes

Assignees
No one assigned
Labels
Area: Documentation Improvements or additions to documentation backport 8.8 backport 8.9
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@szabosteve @swallez