Skip to content
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

Merged
merged 6 commits into from
Jul 30, 2024
Merged

Conversation

benironside
Copy link
Contributor

@benironside benironside commented Jul 23, 2024

This PR fixes issue 23 in our docs projects repo. Updates the ESS docs Getting Started section for 8.14 and 8.15.

  • Moves some requirements pages to the sections about their corresponding features (not all reqs pages were moved, I didn't make the new section for Defend yet)
  • Moves the Elastic Security UI page into the Getting Started section
  • Other minor revisions to the Getting Started

Note: This PR affects organization only. It does not make content updates.

Previews: Getting started section

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

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.

@benironside benironside marked this pull request as ready for review July 24, 2024 16:15
@benironside benironside requested a review from a team as a code owner July 24, 2024 16:15
Copy link
Contributor

@nastasha-solomon nastasha-solomon left a 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.

docs/cases/cases-index.asciidoc Outdated Show resolved Hide resolved
docs/detections/detections-index.asciidoc Outdated Show resolved Hide resolved
@nastasha-solomon nastasha-solomon requested a review from a team July 24, 2024 16:34
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic left a 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/detections/detections-index.asciidoc Outdated Show resolved Hide resolved
…iew.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
joepeeples
joepeeples previously approved these changes Jul 25, 2024
Copy link
Contributor

@joepeeples joepeeples left a 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.

docs/detections/detections-index.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@jmikell821 jmikell821 left a 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/detections/detections-index.asciidoc Outdated Show resolved Hide resolved
include::data-views-in-sec.asciidoc[leveloffset=+1]

include::ingest-data.asciidoc[leveloffset=+1]
Copy link
Contributor

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.

2024-07-25_14-49-41

Copy link
Contributor Author

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.

Copy link
Contributor

@nastasha-solomon nastasha-solomon left a 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!

@benironside benironside merged commit 80a0804 into main Jul 30, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Jul 30, 2024
* 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)
mergify bot pushed a commit that referenced this pull request Jul 30, 2024
* 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)
benironside added a commit that referenced this pull request Jul 30, 2024
* 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>
benironside added a commit that referenced this pull request Jul 30, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants