-
Notifications
You must be signed in to change notification settings - Fork 191
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
Revises IA of the getting started section #5597
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
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.
Thank you for re-orging this! It looks great 👍🏼 Just left two suggestions for your consideration.
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
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.
One suggestion about EA, otherwise looks great! 🚀
docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc
Outdated
Show resolved
Hide resolved
…iew.asciidoc Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
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.
LGTM! Though I was expecting a bit more of an overhaul, esp compared to the outlines in the originating issue and the Google doc, with new "Get started" subsections for each product area (SIEM, Endpoint, Cloud). I assume that'll come in later iterations, and this PR is just the start of the reorg.
Also, maybe a bit out of scope, but we should standardize whether we call things "requirements" or "prerequisites" (or both!), in topic titles and anywhere else. The difference between terms is pretty nuanced and probably lost on most users, so we should just pick one and stick with it. Nothing that needs to go into this PR; we can do that later when we're focusing more on content and not just organization.
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.
Thanks! Left a comment. Also - does this PR move the feature-specific reqs to their respective sections? Or are we doing that in phase 1B?
docs/getting-started/index.asciidoc
Outdated
include::data-views-in-sec.asciidoc[leveloffset=+1] | ||
|
||
include::ingest-data.asciidoc[leveloffset=+1] |
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 would put ingest after Elastic Endgame reqs
, closer to the top. Here's the proposed order according to our doc but I'm open to suggestions.
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 PR move the feature-specific reqs to their respective sections?" - Yes, the only exception being the Elastic Defend stuff since we haven't made a section for it yet.
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.
lgtm - thank you for reorging this!
* Preps getting started section for automatic import doc * troubleshoot build error * Update docs/cases/cases-index.asciidoc Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> * Update docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> * Incorporates feedback --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> (cherry picked from commit 80a0804)
* Preps getting started section for automatic import doc * troubleshoot build error * Update docs/cases/cases-index.asciidoc Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> * Update docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> * Incorporates feedback --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> (cherry picked from commit 80a0804)
* Preps getting started section for automatic import doc * troubleshoot build error * Update docs/cases/cases-index.asciidoc Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> * Update docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> * Incorporates feedback --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> (cherry picked from commit 80a0804) Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
* Preps getting started section for automatic import doc * troubleshoot build error * Update docs/cases/cases-index.asciidoc Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> * Update docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> * Incorporates feedback --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> (cherry picked from commit 80a0804) Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
This PR fixes issue 23 in our docs projects repo. Updates the ESS docs Getting Started section for 8.14 and 8.15.
Note: This PR affects organization only. It does not make content updates.
Previews: Getting started section