Navigation Menu

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

Write getting started guide #845

Merged
merged 4 commits into from Apr 6, 2017
Merged

Conversation

muuki88
Copy link
Contributor

@muuki88 muuki88 commented Mar 23, 2017

I'm starting to write the getting started page on the new documentation site.
There are still some issues, but I want to see if travis plays well with the embedded node
started during documentation compiling.

  • use tut to compile the docs
  • remove all deprecation warnings

Content

  • remove sections from the readme and just link the documentation in these sections
  • fix broken links in readme

// Here we create an instance of the TCP client
val client = TcpClient.transport(
Settings.builder().put("cluster.name", clusterName).build(),
ElasticsearchClientUri(s"elasticsearch://${localNode.ipAndPort}")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wonder why this doesn't work. I don't want to use the localNode.elastic4sClient() because
this examples should show how to start a TcpClient.

@sksamuel
Copy link
Collaborator

Can this address #846

@muuki88
Copy link
Contributor Author

muuki88 commented Mar 24, 2017

I can do it in this PR or in a separate one.

@muuki88
Copy link
Contributor Author

muuki88 commented Apr 3, 2017

Fixed the broken links. Should be good to go.

@muuki88 muuki88 changed the title WIP: Write getting started guide Write getting started guide Apr 3, 2017
@sksamuel sksamuel merged commit e9728db into Philippus:master Apr 6, 2017
@sksamuel
Copy link
Collaborator

sksamuel commented Apr 6, 2017

awesome

@muuki88 muuki88 deleted the docs/compiled branch April 6, 2017 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants