Skip to content

Conversation

joepeeples
Copy link
Contributor

@joepeeples joepeeples commented Sep 11, 2024

Resolves https://github.com/elastic/security-docs-internal/issues/31. Also fixes #6019.

Preview

  • Click the link in the comment below, then in the Security card click View serverless docs.
  • Navigate to: Elastic Security UI → Spaces and Elastic Security

Note that we're no longer trying to omit "Kibana" from serverless docs, as that no longer seems to be a requirement (it's all over the UI). So this content mostly mirrors the ESS version in sometimes referring to spaces as "KIbana spaces," though in some instances this has been shortened to just "spaces" for simplicity.

@joepeeples joepeeples added backport-skip Docset: Serverless Issues for Serverless Security Docset: ESS Issues that apply to docs in the Stack release ci:doc-build labels Sep 11, 2024
@joepeeples joepeeples self-assigned this Sep 11, 2024
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.

@elasticdocs
Copy link

elasticdocs commented Sep 11, 2024

🚀 Built elastic-dot-co-docs-preview-docs successfully!

Issues? Visit #next-docs in Slack

@joepeeples joepeeples marked this pull request as ready for review October 21, 2024 14:23
@joepeeples joepeeples requested a review from a team as a code owner October 21, 2024 14:23
@joepeeples joepeeples enabled auto-merge (squash) October 24, 2024 13:40
Copy link
Contributor

@benironside benironside left a comment

Choose a reason for hiding this comment

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

Left one question, otherwise 🚢 it

tags: [ 'serverless', 'security', 'reference' ]
---

((elastic-sec)) supports the organization of your security operations into logical instances with the <DocLink slug="/serverless/spaces">spaces</DocLink> feature. Each space in ((kib)) represents a separate logical instance of ((elastic-sec)) in which detection rules, rule exceptions, value lists, alerts, Timelines, cases, and ((kib)) advanced settings are private to the space and accessible only by users that have role privileges to access the space. For details about configuring privileges for ((es)) and ((kib)), refer to <DocLink slug="/serverless/security/detections-requirements" section="detections-permissions-section" />.
Copy link
Contributor

Choose a reason for hiding this comment

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

Bit confused why we're linking to detections requirements when the sentence is talking about ES and Kib.

Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to link here instead?

Copy link
Contributor Author

@joepeeples joepeeples Nov 1, 2024

Choose a reason for hiding this comment

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

Hm, good question. This page mostly mirrors the stateful version, which also points to the detections requirements, so this was just going for parity. But it does seem a little weird to focus on just detections requirements, when several other features also have space-bound privilege requirements.

I think something like this general requirements page might be a better link here, since it gives info on space & index privs AND points to other feature-specific req pages. I pushed commit 8fb2584 to change to both serverless and stateful...

@joepeeples joepeeples merged commit 686800d into main Nov 1, 2024
4 checks passed
mergify bot pushed a commit that referenced this pull request Nov 1, 2024
* Add previously omitted spaces page, align with ESS

* Fix typo in description frontmatter

* Minor edit

* Update "Data views in Elastic Security"

Align across platforms, and omit "feature visibility" since it's unavailable in security

* Update "Timeline"

* Update "Timeline templates"

* Update link to general docs on spaces

This link will be broken until elastic/docs-content#55 is merged

* Fix links: targets from stateful to serverless

(cherry picked from commit 686800d)

# Conflicts:
#	docs/serverless/explore/data-views-in-sec.mdx
#	docs/serverless/investigate/timeline-templates-ui.mdx
#	docs/serverless/investigate/timelines-ui.mdx
#	docs/serverless/sec-requirements.mdx
#	docs/serverless/serverless-security.docnav.json
mergify bot pushed a commit that referenced this pull request Nov 1, 2024
* Add previously omitted spaces page, align with ESS

* Fix typo in description frontmatter

* Minor edit

* Update "Data views in Elastic Security"

Align across platforms, and omit "feature visibility" since it's unavailable in security

* Update "Timeline"

* Update "Timeline templates"

* Update link to general docs on spaces

This link will be broken until elastic/docs-content#55 is merged

* Fix links: targets from stateful to serverless

(cherry picked from commit 686800d)

# Conflicts:
#	docs/serverless/explore/data-views-in-sec.mdx
#	docs/serverless/investigate/timeline-templates-ui.mdx
#	docs/serverless/investigate/timelines-ui.mdx
#	docs/serverless/sec-requirements.mdx
#	docs/serverless/serverless-security.docnav.json
joepeeples added a commit that referenced this pull request Nov 1, 2024
* Spaces in serverless (#5813)

* Add previously omitted spaces page, align with ESS

* Fix typo in description frontmatter

* Minor edit

* Update "Data views in Elastic Security"

Align across platforms, and omit "feature visibility" since it's unavailable in security

* Update "Timeline"

* Update "Timeline templates"

* Update link to general docs on spaces

This link will be broken until elastic/docs-content#55 is merged

* Fix links: targets from stateful to serverless

(cherry picked from commit 686800d)

# Conflicts:
#	docs/serverless/explore/data-views-in-sec.mdx
#	docs/serverless/investigate/timeline-templates-ui.mdx
#	docs/serverless/investigate/timelines-ui.mdx
#	docs/serverless/sec-requirements.mdx
#	docs/serverless/serverless-security.docnav.json

* Delete docs/serverless directory and its contents

---------

Co-authored-by: Joe Peeples <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joepeeples added a commit that referenced this pull request Nov 1, 2024
* Spaces in serverless (#5813)

* Add previously omitted spaces page, align with ESS

* Fix typo in description frontmatter

* Minor edit

* Update "Data views in Elastic Security"

Align across platforms, and omit "feature visibility" since it's unavailable in security

* Update "Timeline"

* Update "Timeline templates"

* Update link to general docs on spaces

This link will be broken until elastic/docs-content#55 is merged

* Fix links: targets from stateful to serverless

(cherry picked from commit 686800d)

# Conflicts:
#	docs/serverless/explore/data-views-in-sec.mdx
#	docs/serverless/investigate/timeline-templates-ui.mdx
#	docs/serverless/investigate/timelines-ui.mdx
#	docs/serverless/sec-requirements.mdx
#	docs/serverless/serverless-security.docnav.json

* Delete docs/serverless directory and its contents

---------

Co-authored-by: Joe Peeples <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@joepeeples joepeeples deleted the 31-serverless-spaces branch November 1, 2024 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docset: ESS Issues that apply to docs in the Stack release Docset: Serverless Issues for Serverless Security v8.16.0 v8.17.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Serverless]: Security - Space privileges link goes to stateful instead of serverless

4 participants