Documents new RBAC for value reports #3817
Conversation
🔍 Preview links for changed docs |
florent-leborgne
left a comment
florent-leborgne
left a comment
There was a problem hiding this comment.
Nice one those sections are so useful. I have a few comments/questions.
Also, could it still make sense to add a list item to this section https://www.elastic.co/docs/solutions/security/get-started/elastic-security-requirements#security-requirements-overview-feature-specific-requirements? (the page originally linked in the issue)
| ```{applies_to} | ||
| serverless: preview | ||
| stack: preview 9.3 | ||
| ``` |
There was a problem hiding this comment.
Nice usage of applies_to. One thing though:
- "stack" doesn't exist at the page level. Is the feature available there too?
- This also sounds confusing to me because EASE is a serverless project type and we're in the EASE docs.
Can you look into this? Happy to provide input about what to do once we know more exactly what is available where and what do we need to call out (or locate things) exactly
There was a problem hiding this comment.
Good point Florent. This page was initially introduced just for the EASE feature tier of the Serverless Security project type. It's now available in the security analytics complete feature tier of Serverless Security — and also planned for Stack 9.3.
I've added stack: preview 9.3 at the page level. Also, as part of this PR I made it so that this page appears in two places in the ToC:
- The original place, within the EASE docs (which is a sub-section within the AI docs section)
- A new place, within the AI docs section but not within the EASE sub-section.
My thinking here is that this page should still be findable in the EASE docs since it's one of this feature tier's core features, and it should also be findable when a user is just looking at the AI for Security docs, but not EASE specifically.
What do you think?
There was a problem hiding this comment.
Also, to address your comment about possibly linking to this page from this section, I'd recommend against it. The pages in that section are dedicated specifically to requirements — they aren't feature pages with requirements sections, such as the one this PR updates. I think the link would be out of place there.
There was a problem hiding this comment.
I think the link would be out of place there.
Fine by me, thanks for explaining!
I made it so that this page appears in two places in the ToC
I understand your reasoning here but this isn't well supported in our docs system (it creates 2 pages with the same URL, especially in this case where the 2 pages are close in the TOC, could impair linking, etc.). So we must work around this.
Since it's a core feature of EASE security projects, one approach we could take is:
- Mention and describe it and link to the page in the highlighted features on this page: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/3817/solutions/security/ai/ease/ease-intro#features
- Reading that page ^^ I would even propose moving the Features section just after the page intro (before "Create an EASE project) because at this point knowing what these projects offer might even be more valuable for users)
- Removing the Value report page from the EASE tree, and only keeping it at its new location.
Happy to hear your thoughts on this but I believe we have to find a way to keep only one occurrence of this page, that using snippets wouldn't make sense either here since the entirety of the page makes sense, and that better referencing it from the EASE docs should be sufficient.
There was a problem hiding this comment.
Love this. Implemented it. Thanks!
There was a problem hiding this comment.
I reused much of the content from the EASE value reports page in the Features section. I think it works, but it might be a bit repetitive since the content now appears on both pages. Thoughts?
Co-authored-by: florent-leborgne <[email protected]>
Fixes #3720 — documents a new RBAC control that controls access to the Value Report feature in Elastic Security (only available on serverless security and EASE projects for now — planned for Stack v9.3).
Tweaks the value reports page to make it more generic, since previously it was only available on EASE, and it's now available in serverless.
Although in the original ticket @stephmilovic requested that the new RBAC control be documented here, for this draft I opted to document it directly on the Value Reports page, since the security requirements page is more of a high-level page that isn't focused on specific features (other than linking to other requirements pages that are related to specific features). Instead, I suggest we make the in-product link go to the Value Reports page rather than the security requirements page.
Also added the value reports page to another spot in the GenAI for security section — it's still present in the original spot in the EASE subfolder, but now that it's available in serverless too, I wanted to make it more findable.