[DOCS][101] Create Elasticsearch basics section, refactor quickstarts section #112436
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- **index.asciidoc**:
- Added a reference to a new document: `scalability.asciidoc`.
- **intro.asciidoc**:
- Changed the section title from "What is {es}?" to "{es} 101".
- Added a detailed explanation for beginners under "{es} 101", covering:
- Basic information about Elasticsearch.
- Key features and deployment.
- Data storage and ingestion.
- Data searching and analyzing.
- Planning for scalability and resilience.
- Updated the "Deployment options" section, adding quick start options and enhancing existing content for clarity.
- Title changed from "{es} 101" to "Getting started with Elasticsearch"
- Updated content to be more welcoming for new users, with clear guidance on how to use the docs effectively.
- Added guidance on data ingestion, searching, analyzing data.
- **getting-started.asciidoc** (within quickstart directory):
- Updated the guide title to "Quick start: First steps with {es}" for clarity and focus.
- Streamlined content to specifically teach how to add a small dataset to Elasticsearch and perform basic searches, targeting new users or those in initial learning phases.
- Removed tab widget and delegate all deployment info to deployment doc
-
- **index.asciidoc** (within quickstart directory):
- Renamed from "Quickstart" to "Quickstarts" .
- Added a new "Requirements" section detailing prerequisites for using the quickstarts effectively.
- Introduced a new "Working in Python" section pointing to Python stuff
- **run-elasticsearch-locally.asciidoc**:
- Moved into overall Set up Elasticsearch section, now that we have nice signposting
|
Documentation preview: |
|
run docs-build |
|
run docs-build |
Eventually I want this to live further down the nav but it requires messing with heading levels more than I can justify right now.
leemthompo
commented
Sep 5, 2024
leemthompo
commented
Sep 5, 2024
leemthompo
commented
Sep 11, 2024
Co-authored-by: shainaraskas <[email protected]>
leemthompo
commented
Sep 24, 2024
Co-authored-by: shainaraskas <[email protected]>
leemthompo
commented
Sep 25, 2024
leemthompo
added a commit
to leemthompo/elasticsearch
that referenced
this pull request
Sep 25, 2024
…ion (elastic#112436) Co-authored-by: shainaraskas <[email protected]>
leemthompo
added a commit
to leemthompo/elasticsearch
that referenced
this pull request
Sep 25, 2024
…ion (elastic#112436) Co-authored-by: shainaraskas <[email protected]>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Sep 25, 2024
…ion (#112436) (#113543) Co-authored-by: shainaraskas <[email protected]>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Sep 25, 2024
…ion (#112436) (#113542) Co-authored-by: shainaraskas <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow up to #112213 and #112394
👀 Standard PR URL preview
☝️ See the live page preview
Summary of changes
ℹ️
docs/reference/intro.asciidochas big diff, need to expand under Files changed to see changesAdd new page: Start with the REST APIstart-localsoonNote
See commit messages for more details.
Context
I've tried to work on all these pages at the same time because it was more efficient. However, this is now a big PR. The goal is not to merge all these changes at once.
Hopefully we get a URL preview and we'll use that as the basis for further discussions and can tactically update pages.
Tip
Definitely don't want wording edits immediately until we've agreed on how to proceed. Will try to have conversation in markup.io to enable free form commenting :)