Skip to content

Conversation

@benironside
Copy link
Contributor

Addresses #2260 by adding stub pages for the new KSPM docs to address broken link/build failure issues.

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.

I think all of this is fine. I'm not too familiar with this type of set-up though, so I'll let @joepeeples verify.

@joepeeples
Copy link
Contributor

joepeeples commented Aug 17, 2022

I think the links are OK, but the page locations might need a little reorganizing. As of #2289 we're renaming the "Manage" section to "Endpoint management," so that the overall section is no longer mirroring what's in the nav but just describing a general function around endpoints.

It'd probably be better to have the "Benchmark rules" page in a separate main section that's all about cloud stuff, which I don't think we currently have but could create. So instead of adding that file as an include in manage-intro.asciidoc, you could add it to the index/intro file for a cloud section. (Would that be cloud-native-security-overview.asciidoc? Where is that page going to be located in the docs?)

@benironside
Copy link
Contributor Author

I think the links are OK, but the page locations might need a little reorganizing. As of #2289 we're renaming the "Manage" section to "Endpoint management," so that the overall section is no longer mirroring what's in the nav but just describing a general function around endpoints.

It'd probably be better to have the "Benchmark rules" page in a separate main section that's all about cloud stuff, which I don't think we currently have but could create. So instead of adding that file as an include in manage-intro.asciidoc, you could add it to the index/intro file for a cloud section. (Would that be cloud-native-security-overview.asciidoc? Where is that page going to be located in the docs?)

Sounds good to add the Benchmark rules page to the Cloud Native Security section, thanks. That section is going to go under Detections and Alerts.

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.

Structure looks good! Exciting to see new cloud features getting top billing in the docs.

[[cloud-native-security-overview]]

= Cloud native security
Elastic’s cloud security capabilities help you to improve your Kubernetes security posture by comparing your configuration to best practices, and help you monitor and investigate your Linux deployments inside and outside of Kubernetes. This is an area of focus for Elastic Security, and you can expect many more cloud security features in future releases.
Copy link
Contributor

Choose a reason for hiding this comment

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

The second sentence sounds more like a blog or marketing statement, and even though it's pretty general we try to avoid forward-looking statements that seem to "promise" things.

I know the focus of this PR is more about structure than content, so we can do a closer review later if there's more to come for this section.

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 definitely nix the second sentence.

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.

@benironside just one small comment piggybacking off what @joepeeples mentioned, otherwise LGTM!

[[cloud-native-security-overview]]

= Cloud native security
Elastic’s cloud security capabilities help you to improve your Kubernetes security posture by comparing your configuration to best practices, and help you monitor and investigate your Linux deployments inside and outside of Kubernetes. This is an area of focus for Elastic Security, and you can expect many more cloud security features in future releases.
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 definitely nix the second sentence.

@benironside benironside merged commit 8a4ed8f into main Aug 17, 2022
mergify bot pushed a commit that referenced this pull request Aug 17, 2022
* Creates stubs for KSPM 8.4 docs to fix linking issues

* Fix benchmark rules page title

* Fixes build failures

* Addresses Joe's feedback

* Update cloud-native-security-index.asciidoc

(cherry picked from commit 8a4ed8f)
nastasha-solomon pushed a commit to nastasha-solomon/security-docs that referenced this pull request Sep 19, 2022
* Creates stubs for KSPM 8.4 docs to fix linking issues

* Fix benchmark rules page title

* Fixes build failures

* Addresses Joe's feedback

* Update cloud-native-security-index.asciidoc

(cherry picked from commit 8a4ed8f)

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