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] Add Quick Start page #40903

Closed
wants to merge 8 commits into from
Closed

[DOCS] Add Quick Start page #40903

wants to merge 8 commits into from

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Apr 5, 2019

Creates a high-level, tutorial-based introduction to Elasticsearch and its basic features.
Resolves #40861.

Welcome any and all feedback.

Firebase preview

https://es-demo-docs.firebaseapp.com/quick-start.html

Notes

  • I intentionally avoided more complex or architecture-related concepts, like nodes and clusters.
  • I left out Java requirements. It looks like we'll be bundling JDK with our distro in 7.0+.
  • My examples used data from the Kibana accounts sample set. Happy to update this if we prefer to use the more common twitter examples.
  • I'm not particularly happy with the instances of 'a document with an ID of X' throughout. I'd appreciate any suggestions for alternate wording.

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@jrodewig jrodewig added the :Search/Search Search-related issues that do not fall into other categories label Apr 5, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search

@jrodewig jrodewig added the v7.0.0 label Apr 5, 2019

[float]
=== Install and run {es}

Copy link
Contributor

Choose a reason for hiding this comment

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

This section reminds me a lot of https://www.elastic.co/guide/en/elastic-stack-get-started/master/get-started-elastic-stack.html#install-elasticsearch

If you agree, perhaps we can combine the content and just re-use it in both places (e.g. via a tagged region). I'm happy to help with that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That sounds great! I'll go ahead and add a tag to this section. I'll look into combining the two docs as part of another issue/PR.

==== Autogenerate a document ID

To add a document without providing an ID, use the POST method with the
<<docs-index_, index API>>. {es} will automatically generate an ID for the
Copy link
Contributor

Choose a reason for hiding this comment

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

I generally try to avoid future tense, but it's not a hard rule.

Suggested change
<<docs-index_, index API>>. {es} will automatically generate an ID for the
<<docs-index_, index API>>. {es} automatically generates an ID for the

@lcawl
Copy link
Contributor

lcawl commented Apr 5, 2019

I added a few minor comments but it builds successfully and generally LGTM. If you're still encountering gradle errors and need help debugging, let me know!

@polyfractal polyfractal removed the v7.0.0 label Apr 9, 2019
@jrodewig
Copy link
Contributor Author

jrodewig commented Apr 25, 2019

The @esdocs team met and discussed this PR. Here's a summary:

  • We currently risk proliferating too many "Getting Started" and "Quick Start" guides across the Elastic Stack. This is particularly true for installation instructions.
  • There are ongoing efforts to consolidate this type of content in the Getting Started with Elastic Stack guide.
  • @kat257 and others will lead efforts to inventory our current "start" documentation.
  • To prevent further proliferation, we'll close this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search/Search Search-related issues that do not fall into other categories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Add Quick Start Page
4 participants