Add new Elastic intro section #2795
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.
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.
is it on your roadmap to fix links to this section from the landing page?
There was a problem hiding this comment.
| |  | **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.
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.
we also leave out geospatial engine which is a key element of the platform.
There was a problem hiding this comment.
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.
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.
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
|
👋 @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 |
There was a problem hiding this comment.
General comment: We need to align on product order.
- Elastic.co and the introductory diagram use 1-Search 2-Security 3-Observability.
- Most of the remaining in intro content and release notes use 1-Elasticsearch 2-Observability 3-Security.
- Reference content lists 1-Elasticsearch 2-Security 3-Observability.
This is shaping up nicely!
| <!--TBD: Call out how solutions map to Serverless project types? --> | ||
| <!-- Content moved from the-stack.md |
There was a problem hiding this comment.
@theletterf, what's your plan for this content? I have ideas, but would like to hear what you have in mind first.
We need to have "ingest" or "ingestion" in the headings for ingest content for better SEO ranking and for easier visual scanning for key words.
There was a problem hiding this comment.
@karenzone Agreed. I think we need to add something about ingest in the section, although it wasn't initially scoped. We also have this page, so we could consider repurposing some of it: https://www.elastic.co/docs/manage-data/ingest/ingesting-data-for-elastic-solutions
I suggest talking about this in our ingest call next week and plan for a follow-up PR that all ingest writers can contribute to.
There was a problem hiding this comment.
We have nice, discrete sections for ingesting data for each of the solutions. I suggest that we add an ingest section for each at the same level as Overview. Use cases, and Core concepts.
Nothing happens until data is ingested. Providing ingest content here offers users information on next steps.
There was a problem hiding this comment.
Thanks for your feedback, @karenzone! I agree with you, but we'd prefer for the ingest info to be in a separate topic (likely the following topic after this one). This overview topic is meant to be high-level and informational, then we can dive into ingest after since that's the next logical step.
get-started/introduction.md
Outdated
| | Build powerful, scalable searches to quickly search, analyze, and visualize large amounts of data for real-time insights | [{{es}}](/solutions/search.md) | Developers, architects, data engineers | | ||
| | Observe and monitor system health and performance or send telemetry data | [Elastic {{observability}}](/solutions/observability.md) | DevOps, SREs, IT operations | | ||
| | Monitor data for anomalous activity, detect, prevent, and respond to security incidents | [{{elastic-sec}}](/solutions/security.md) | SOC teams, security analysts, IT security admins | |
There was a problem hiding this comment.
What's the best place for these product links to point to? As the links are formatted in the table, I would expect them to send me deeper into the introductory content, not immediately launch me out of the intro and right into the solution docs. If a user has sought out this intro content, maybe we should keep them here a while longer.
There are good arguments either way, but the link text should accurately set user expectations for where they'll land.
There was a problem hiding this comment.
+CC @lcawl @jmikell821
|
Since there are terminology change discussions outside the timeline of this PR, I've moved the changes related to the Elastic Stack page to #2922 instead. |
Quick commit to save changes, then circling back.
This rebuilds the Get Started section into the Elastic fundamentals section to improve Onboarding experience.
Pending: