-
Notifications
You must be signed in to change notification settings - Fork 193
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
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. |
@elasticmachine run elasticsearch-ci/docs |
@elasticmachine run elasticsearch-ci/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.
This is a great first draft, @benironside! I left some suggestions for organizing the content on the overview page. Let me know your thoughts :)
Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: Nastasha Solomon <[email protected]>
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.
Really great, streamlined overview! A few fairly localized suggestions to consider, thanks for taking on this effort!
include::{security-docs-root}/docs/management/admin/endpoint-self-protection.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.
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"?
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.
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.
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.
Left a couple of suggestions but looks great overall! 🚀
Co-authored-by: natasha-moore-elastic <[email protected]>
* 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)
* 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]>
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