[DOCS] Rewrite "What is Elasticsearch?" (Part 1) #112213

leemthompo · 2024-08-26T15:57:43Z

Part 1: Focus on practical info: high-level overview of deployment, use cases, helpful links. Remove outdated and messy content.

Consider all links as placeholders and please suggest alternatives.

URL preview ✨

TODO

Use attributes for URLs

Follow up work for this page

Coming in future PRs:

Rewrite indices and shard/scalability info. (In a How Elasticsearch works? subpage perhaps). Explain indices, fields, and all the under-the-hood goodness. Use a new asciidoc file for legibility instead of chunking single source page into multiple HTML pages.
Move Elastic Stack overview from different book into this section as subpage
Create a concise features overview as subpage (optional)

github-actions · 2024-08-26T15:57:55Z

Documentation preview:

✨ Changed pages

elasticsearchmachine · 2024-08-26T16:02:28Z

Pinging @elastic/es-docs (Team:Docs)

szabosteve

Just saw this PR and wanted to read it immediately. It's great and very exciting! Sorry, left a couple of minor suggestions mostly about using attributes more consistently – hope that's okay. Please take or leave them!

docs/reference/intro.asciidoc

docs/reference/modules/shard-ops.asciidoc

Co-authored-by: István Zoltán Szabó <[email protected]>

shainaraskas

this is infinitely better!

left a lot of thoughts but not all of them need to be addressed right now. however, I am concerned about removing content in this PR without a replacement.

docs/reference/intro.asciidoc

shainaraskas · 2024-08-27T20:03:10Z

docs/reference/intro.asciidoc

+=== Deployment options
+
+To use {es}, you need a running instance of the {es} service.
+You can deploy {es} in various ways:


I think we clearer "some of these cost money and some of these are free" messaging. ECE and ECK are especially confusing in comparison to self-managed. can also be a follow-up

I think it's OK to just list the options and let devs decide. Free trials imply paid services. And honestly I don't think anyone "gets started" with ES by using ECE or ECK. I like concision here and we have links to learn more.

Maybe we could categorize self-managed, ECE, and ECK into an "advanced deployment" options section

that would work for me, although self-managed is also the beginner/builder path

that's why local dev has its own category and has top billing 😄

docs/reference/intro.asciidoc

docs/reference/modules/shard-ops.asciidoc

marciw

Just a couple small comments for now -- going to do a more complete review tomorrow.

docs/reference/intro.asciidoc

shainaraskas

good to go from my perspective (after link fixes)?

shainaraskas · 2024-08-28T15:33:21Z

docs/reference/intro.asciidoc

-++++
-<titleabbrev>Scalability and resilience</titleabbrev>
-++++
+=== Scalability and resilience


these headings are so much better ty

marciw

So much clearer. Not sure why I'm obsessed with hyphens this week -- feel free to ignore me, because the substantive stuff is already so much better with your revisions. 🥇

marciw · 2024-08-28T18:43:22Z

docs/reference/search/search-your-data/near-real-time.asciidoc

@@ -2,7 +2,7 @@

 [[near-real-time]]
 === Near real-time search
-The overview of <<documents-indices,documents and indices>> indicates that when a document is stored in {es}, it is indexed and fully searchable in _near real-time_--within 1 second. What defines near real-time search?
+When a document is stored in {es}, it is indexed and fully searchable in _near real-time_--within 1 second. What defines near real-time search?


I'm now realizing we often have a hyphen in the noun form (there's one here, _near real-time_), and arguably we'd need to add one to "near-real-time search" if we're being picky, which isn't worth it.

So it'd be fair to undo that other change I suggested, and just standardize on the hyphenated form for simplicity and readability.

docs/reference/intro.asciidoc

marciw · 2024-08-28T18:47:37Z

docs/reference/intro.asciidoc

-++++
-<titleabbrev>Scalability and resilience</titleabbrev>
-++++
+=== Scalability and resilience


docs/reference/intro.asciidoc

Co-authored-by: marciw <[email protected]>

(cherry picked from commit aa57a15)

leemthompo · 2024-08-29T09:13:37Z

💚 All backports created successfully

Status	Branch	Result
✅	8.15
✅	8.14

Questions ?

Please refer to the Backport tool documentation

(cherry picked from commit aa57a15)

leemthompo added 3 commits August 26, 2024 17:42

First draft of what is elasticsearch rewrite

85f1d7a

Move clients link

1c2eb0d

Remove backlinks

8b794e9

leemthompo added auto-backport-and-merge v8.14.0 v8.15.0 v8.16.0 labels Aug 26, 2024

leemthompo requested review from marciw, georgewallace and shainaraskas August 26, 2024 15:57

leemthompo self-assigned this Aug 26, 2024

elasticsearchmachine added the needs:triage Requires assignment of a team area label label Aug 26, 2024

Make link text conform

f138524

leemthompo added >docs General docs changes and removed needs:triage Requires assignment of a team area label labels Aug 26, 2024

elasticsearchmachine added the Team:Docs Meta label for docs team label Aug 26, 2024

Add back indices page

3062ac9

szabosteve reviewed Aug 27, 2024

View reviewed changes

docs/reference/intro.asciidoc Outdated Show resolved Hide resolved

docs/reference/intro.asciidoc Outdated Show resolved Hide resolved

docs/reference/modules/shard-ops.asciidoc Outdated Show resolved Hide resolved

Use attributes

56cfb44

Co-authored-by: István Zoltán Szabó <[email protected]>

shainaraskas reviewed Aug 27, 2024

View reviewed changes

docs/reference/modules/shard-ops.asciidoc Outdated Show resolved Hide resolved

marciw reviewed Aug 27, 2024

View reviewed changes

docs/reference/intro.asciidoc Outdated Show resolved Hide resolved

docs/reference/intro.asciidoc Outdated Show resolved Hide resolved

leemthompo added 6 commits August 28, 2024 10:23

Review feedback, add back deleted pages, refactor

69612ac

Fix conflicts

84575cc

Revert merging subpages which breaks backlinks 😖

757f9c1

Restore link

bde3cce

Fix the the

832eb3f

Delete whitespace

9ec6718

Restore single whitespace to remove noise because this file is unchanged

dcf5050

shainaraskas approved these changes Aug 28, 2024

View reviewed changes

Trim Stack callout, use URL attributes where possible

238ec7d

marciw approved these changes Aug 28, 2024

View reviewed changes

Fix hyphens

acc90b5

Co-authored-by: marciw <[email protected]>

leemthompo merged commit aa57a15 into elastic:main Aug 29, 2024
5 checks passed

This was referenced Aug 29, 2024

[8.15] [DOCS] Rewrite What is Elasticsearch? (Part 1) #112335

Merged

[8.14] [DOCS] Rewrite What is Elasticsearch? (Part 1) #112336

Merged

leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Aug 29, 2024

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) (elastic#112213)

1abf332

(cherry picked from commit aa57a15)

leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Aug 29, 2024

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) (elastic#112213)

68c77d1

(cherry picked from commit aa57a15)

leemthompo added a commit that referenced this pull request Aug 29, 2024

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) (#112213) (#112335)

cb49466

(cherry picked from commit aa57a15)

leemthompo added a commit that referenced this pull request Aug 29, 2024

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) (#112213) (#112336)

b99dc37

(cherry picked from commit aa57a15)

dakrone pushed a commit to dakrone/elasticsearch that referenced this pull request Aug 30, 2024

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) (elastic#112213)

f27a4ea

leemthompo mentioned this pull request Sep 2, 2024

[DOCS][101] Create Elasticsearch basics section, refactor quickstarts section #112436

Merged

cbuescher pushed a commit to cbuescher/elasticsearch that referenced this pull request Sep 4, 2024

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) (elastic#112213)

e73ba88

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) #112213

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) #112213

leemthompo commented Aug 26, 2024 •

edited

Loading

github-actions bot commented Aug 26, 2024

elasticsearchmachine commented Aug 26, 2024

szabosteve left a comment •

edited

Loading

shainaraskas left a comment •

edited

Loading

shainaraskas Aug 27, 2024

leemthompo Aug 28, 2024

leemthompo Aug 28, 2024

shainaraskas Aug 28, 2024

leemthompo Aug 28, 2024

shainaraskas Aug 28, 2024

marciw left a comment

shainaraskas left a comment

shainaraskas Aug 28, 2024

marciw Aug 28, 2024

marciw left a comment

marciw Aug 28, 2024

marciw Aug 28, 2024

leemthompo commented Aug 29, 2024

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) #112213

[DOCS] Rewrite "What is Elasticsearch?" (Part 1) #112213

Conversation

leemthompo commented Aug 26, 2024 • edited Loading

TODO

Follow up work for this page

github-actions bot commented Aug 26, 2024

elasticsearchmachine commented Aug 26, 2024

szabosteve left a comment • edited Loading

Choose a reason for hiding this comment

shainaraskas left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marciw left a comment

Choose a reason for hiding this comment

shainaraskas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marciw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leemthompo commented Aug 29, 2024

💚 All backports created successfully

Questions ?

leemthompo commented Aug 26, 2024 •

edited

Loading

szabosteve left a comment •

edited

Loading

shainaraskas left a comment •

edited

Loading