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

Reworks the security docs landing page #4528

Merged
merged 12 commits into from
Feb 12, 2024
Merged

Conversation

benironside
Copy link
Contributor

@benironside benironside commented Dec 28, 2023

Fixes #4527 by making a first pass at a newer Elastic Security landing page, following our team's discussion of ways to improve this page. Does not yet include the advanced (box-style) formatting present in the Observability and overall docs landing pages, but is intended as a starting point for this work / step in the right direction.

We need to decide as a team whether to implement some version of this, or to wait until we can implement a more highly-formatted / CSS-reliant version. I'm leaning towards implementing some version of this since I think it provides a more streamlined UX than the existing page, and we can implement it very soon — but open to other opinions.

This PR also moves content about Endpoint self-protection features to a new page, while preserving the section header on the landing page because it's linked to from this fleet overview page. Once we merge this PR and the new self-protection page exists, I can change the link on that fleet page to go to the new page, and then in a new PR I can remove the section from the security landing page.

As you review, please consider changes we could make that would improve how well this page functions as a landing page / starting point, and whether it's an improvement over our existing page and therefore worth implementing in the short term. Thanks!

Previews: Elastic Security overview/landing page
Endpoint self-protection

@benironside benironside added enhancement New feature or request Priority: Medium Issues that have relevance, but aren't urgent Effort: Large Issues that require significant planning, research, writing, and testing v8.12.0 labels Dec 28, 2023
@benironside benironside requested a review from a team as a code owner December 28, 2023 17:42
@benironside benironside self-assigned this Dec 28, 2023
Copy link

A documentation preview will be available soon.

Help us out by validating the Buildkite preview and reporting issues here.
Please also be sure to double check all images to ensure they are correct in the preview.

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
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

@benironside benironside requested review from tinnytintin10 and removed request for tinnytintin10 January 1, 2024 23:51
@benironside
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

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.

This is a great first draft, @benironside! I left some suggestions for organizing the content on the overview page. Let me know your thoughts :)

docs/es-overview.asciidoc Outdated Show resolved Hide resolved
docs/es-overview.asciidoc Outdated Show resolved Hide resolved
docs/es-overview.asciidoc Outdated Show resolved Hide resolved
docs/es-overview.asciidoc Show resolved Hide resolved
@nastasha-solomon nastasha-solomon requested a review from a team January 29, 2024 21:40
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.

Really great, streamlined overview! A few fairly localized suggestions to consider, thanks for taking on this effort!

docs/es-overview.asciidoc Show resolved Hide resolved
docs/es-overview.asciidoc Outdated Show resolved Hide resolved
docs/es-overview.asciidoc Outdated Show resolved Hide resolved
Comment on lines +18 to +19
include::{security-docs-root}/docs/management/admin/endpoint-self-protection.asciidoc[leveloffset=+1]
Copy link
Contributor

@joepeeples joepeeples Jan 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These pages feel a little out of place here. They're admin-level setup and reference stuff, vs analyst-level UI features like the rest of this section (response console, trusted apps, event filters, etc.). Maybe "Get started > Endpoint requireements" or some other sub-section in "Get started"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good point and I'm making a note of it, but I'd like to do it in a separate PR to keep this one focused, if that's alright.

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.

Left a couple of suggestions but looks great overall! 🚀

docs/es-overview.asciidoc Show resolved Hide resolved
docs/es-overview.asciidoc Outdated Show resolved Hide resolved
@benironside benironside merged commit a40ca23 into main Feb 12, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Feb 12, 2024
* First draft. Complete rework of security landing page

* troubleshoot build error

* fixes broken link

* moves self-protection content to a new page

* Update docs/es-overview.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/es-overview.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/es-overview.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* incorporates feedback

* Update docs/es-overview.asciidoc

Co-authored-by: natasha-moore-elastic <[email protected]>

* incorporates Nat's feedback

---------

Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: natasha-moore-elastic <[email protected]>
(cherry picked from commit a40ca23)
benironside added a commit that referenced this pull request Feb 12, 2024
* First draft. Complete rework of security landing page

* troubleshoot build error

* fixes broken link

* moves self-protection content to a new page

* Update docs/es-overview.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/es-overview.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* Update docs/es-overview.asciidoc

Co-authored-by: Nastasha Solomon <[email protected]>

* incorporates feedback

* Update docs/es-overview.asciidoc

Co-authored-by: natasha-moore-elastic <[email protected]>

* incorporates Nat's feedback

---------

Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: natasha-moore-elastic <[email protected]>
(cherry picked from commit a40ca23)

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Effort: Large Issues that require significant planning, research, writing, and testing enhancement New feature or request Priority: Medium Issues that have relevance, but aren't urgent v8.12.0
Projects
Development

Successfully merging this pull request may close these issues.

Homepage rework
4 participants