-
Notifications
You must be signed in to change notification settings - Fork 137
Add new Elastic intro section #2795
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
base: main
Are you sure you want to change the base?
Conversation
@lcawl @jmikell821 We need to decide what to do with Edit: Removed and added a redirect. |
…cs-content into add-elastic-new-intro-section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
overall, I think these changes are too shallow when it comes to the platform overview, and too deep when it comes to docs about docs. have these changes been planned with consideration for people's pain points when first getting started with our platform?
I think we need to spend more time explaining what our components are (in quite a bit of detail), how they fit together, and the "landscape" of elastic. also, explaining the implications of the various choices users need to make when getting started. I worry that some of the cuts that were made when repositioning this will give us fewer ledges to cling onto when trying to provide core definitions of our offerings (especially when it comes to "what is elasticsearch? what is kibana? what is fleet?").
I advise tripling down on depth of information overall.
|
||
## Overview [what-is-es] | ||
# Elastic fundamentals |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it on your roadmap to fix links to this section from the landing page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
get-started/the-stack.md
Outdated
|
||
### Ingest [_ingest] | ||
### Ingest data from a wide variety of sources |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we still need some single place to define the stack. removing the diagram that showed how the pieces fit together I think is a loss. we need somewhere someone can see what all of the stack components do and how they fit into a deployment (and a list of what counts as a stack component).
we no longer even have the ingest components listed here. that's concerning to me. in general, I think this should have a link density of about 10x what it has now.
we link to this page from a ton of places, with the assumption that it defines stack components and their relationships.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't get much cleanup done on this section before moving to the PR so I can take a crack at it again this week. I advocated for downplaying the "here's a list of all our products" when I had the mindset that this was for people "getting started" who (1) could be coming from Serverless where a lot of this is more seamless and (2) needed more of a explanation of the high level benefits than the product buffet. Given that this is now a "fundamentals" section, however, I think it's fair to re-add an (updated) product map.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we definitely need to maintain an explanation of what the stack is especially given the url of this page
I'd like a clear definition of the Search AI Platform, from how this currently reads "Search AI platform" ==
something built around the stack
I'd like to see more connective tissue between these two:
- here's what the stack is in terms of all the standalone "products" which are its components
- the core components when combined are the platform
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
coming from Serverless where a lot of this is more seamless
This is totally something we can say here as well when we define it and link again to the deployment models section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just as an update, I'll refrain from making more updates to this page until we get confirmation about the hierarchical diagram we can use and clarity about the "search ai platform" and "elastic stack" overlap
|  | **Security**<br> Monitor logs, metrics, and traces to gain insight into your systems.<br><br>[**Get started →**](../solutions/security/get-started.md)<br> | | ||
|
||
## Next steps | ||
Elastic provides an open source search, analytics, and AI platform, and out-of-the-box solutions for observability and security. The Search AI platform combines the power of search and generative AI to provide near real-time search and analysis with relevance to reduce your time to value. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A key area we are missing here and have heard from engineering and our customers is the lack of visibility that we are also just a great vector database which is missing from this overview. would recommend we double down in here about being a vector database (we strive to be the best one). Should probably have a bit of focus on it just being a data store as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we also leave out geospatial engine which is a key element of the platform.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed the same thing about lack of a "vector database" story when cleaning up quickstarts. Since there was nowhere in the docs to link to for that concept, I linked to https://www.elastic.co/what-is/vector-database as a stop-gap but will refrain from doing so here.
Relates to https://github.com/elastic/docs-content-internal/issues/174 where the question of where/how we develop that story in the docs is discussed.
get-started/next-steps-resources.md
Outdated
|
||
Here is a detailed breakdown of the documentation structure: | ||
|
||
* **Elastic fundamentals**: Understand the basics of Elasticsearch and the Elastic Stack, deployment options, and key use cases. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we lost all of the use cases that we used to have around hybrid search, user monitoring, RAG, etc. I don't see that anymore in the new docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I advocated for the removal of the use cases from https://www.elastic.co/docs/get-started/introduction since it was a duplication of https://www.elastic.co/docs/solutions/search (we now link there from https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2795/get-started/the-stack instead). If you have thoughts on why the former is a better spot (or the need for duplication), lmk
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
products: | ||
- id: elastic-stack | ||
--- | ||
# {{search-platform}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lcawl @jmikell821 We must put a redirect in place.
Saving changes.
…cs-content into add-elastic-new-intro-section
|
||
[Learn more about {{kib}}](/explore-analyze/index.md). | ||
|
||
### {{es}} clients [stack-components-elasticsearch-clients] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this belong to Explore?
Use {{kib}} to explore and visualize the data that's stored in {{es}} and to manage the {{search-platform}}. | ||
You can use the {{es}} clients to access data directly by using common programming languages. | ||
|
||
### {{kib}} [stack-components-kibana] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think here we need to present Kibana not only as a set of Analytics features but also as where all solutions (and their dedicated capabilities) come to life
👋 @theletterf I'm planning to take a pass reviewing this from the ingest docs perspective this week. Can you point me to any issues/docs/discussions that outline the goals of this PR? I just want to make sure I have context on what problems it's solving before adding to the (already long) list of comments here. 🙂 |
@colleenmcginnis Sharing a link via Slack |
This rebuilds the Get Started section into the Elastic fundamentals section to improve Onboarding experience.
Pending: