Skip to content

Commit 9012a73

Browse files
authored
Merge branch 'main' into 11-custom-roles-remove-conditions
2 parents 6c5faa7 + ed14429 commit 9012a73

File tree

115 files changed

+900
-168
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

115 files changed

+900
-168
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: "Breaking change report"
2+
description: "Report a breaking change in Elastic Security"
3+
title: "[BREAKING CHANGE] "
4+
labels: "breaking-change"
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Hello! Use this form to report a breaking change in Elastic Security software to the [@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs) team. We will add it to the release notes for the version that introduces the breaking change.
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Description
14+
description: What feature will break? Any more details about how it will break? Please include any recommendations for users who were using the feature with the breaking change.
15+
validations:
16+
required: true
17+
- type: dropdown
18+
id: doc-set
19+
attributes:
20+
label: Which deployment types are affected?
21+
description: ESS (classic), serverless, or both?
22+
options:
23+
- ESS and serverless
24+
- ESS only
25+
- Serverless only
26+
- Unknown
27+
default: 0
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: software-version
32+
attributes:
33+
label: Release version
34+
description: If you selected ESS above, please list which Stack version(s) this breaking change applies to.
35+
placeholder: |
36+
For example:
37+
"This breaking change applies to Stack versions 8.10 and newer."
38+
"N/A"
39+
validations:
40+
required: false

.github/ISSUE_TEMPLATE/docs-request-internal.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: "Internal documentation request (Elastic employees) "
2-
description: Request a documentation change or enhancement. For tasks you don't want exposed to the public, create an issue in [elastic/security-docs-internal](https://github.com/elastic/security-docs-internal).
1+
name: "Doc request for a new feature or enhancement (Elastic employees only)"
2+
description: Request documentation for a new feature or enhancement.
33
title: "[Request] "
44
body:
55
- type: markdown
Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
name: "Security docs enhancement request"
2-
description: Submit an issue to request an improvement to Elastic Security documentation.
3-
title: "[Enhancement]: "
4-
labels: "enhancement"
1+
name: "Request a documentation improvement"
2+
description: Request a change to improve Elastic Security docs.
3+
title: "[Suggestion] "
4+
labels: "suggestion"
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Hello! Use this form to submit an enhancement request to the [@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs) team.
9+
Hello! Do you see something in our docs that needs clarification, more info, or something else we can improve? Use this form to submit a request to our [@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs) team.
1010
- type: textarea
1111
id: description
1212
attributes:
13-
label: Description
14-
description: Summarize your request here. What is the problem?
13+
label: What can we change to make the docs better?
14+
description: Please describe what the issue is and what we can do to improve it.
1515
placeholder: |
1616
What: We need documentation for X.
1717
Why: We've received support requests that indicate customers are struggling with Y in versions A and B.
@@ -20,15 +20,12 @@ body:
2020
- type: textarea
2121
id: related
2222
attributes:
23-
label: Related links / assets
23+
label: Doc URL
2424
description: How can we learn more about the problem?
2525
value: |
26-
Please include each of the following, if applicable:
26+
Please include the doc URL and any other related information where applicable:
2727
Doc URL:
28-
Subject matter expert:
29-
Figma link(s):
30-
Github epic link(s):
31-
Github issue link(s):
28+
Github issue link(s)/Other resources:
3229
validations:
3330
required: false
3431
- type: dropdown
@@ -55,28 +52,7 @@ body:
5552
"The docs are good after version 8.10, but need updating in 8.7, 8.8, and 8.9"
5653
validations:
5754
required: true
58-
- type: textarea
59-
id: collaborators
60-
attributes:
61-
label: Collaborators
62-
description: If applicable, please include contact information for the relevant product manager, designer, and developer.
63-
value: |
64-
PM:
65-
Designer:
66-
Developer:
67-
Others (if applicable):
68-
validations:
69-
required: false
70-
- type: textarea
71-
id: timeline
72-
attributes:
73-
label: Timeline / deliverables
74-
description: When would it be ideal for for us to complete the request?
75-
placeholder: |
76-
Please provide any information that would help us prioritize this request.
77-
validations:
78-
required: true
7955
- type: markdown
8056
attributes:
8157
value: |
82-
Thanks for submitting this issue! For urgent issues, we encourage you to send a message in the [#security-docs](https://elastic.slack.com/archives/C013W8WME2Z) Slack channel.
58+
Thanks for submitting this issue! For urgent issues, we encourage you to send a message in the [#security-docs](https://elastic.slack.com/archives/C013W8WME2Z) Slack channel.

.github/ISSUE_TEMPLATE/issue.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,18 @@ Documentation Manager: Janeen Roberts (Github: `@jmikell821`)
99

1010
## Contributing to Elastic Security docs
1111

12-
If you're an Elastic employee, you can open an issue using the appropriate [template](https://github.com/elastic/security-docs/issues/new/choose). To contribute directly to Elastic Security documentation:
12+
You can open an issue using the appropriate [template](https://github.com/elastic/security-docs/issues/new/choose).
13+
14+
> [!NOTE]
15+
> Please report any **known issues** that need to be documented by creating an issue in our [private repo](https://github.com/elastic/security-docs-internal/issues) using the known issue template.
16+
17+
To contribute directly to Elastic Security documentation:
1318

1419
1. Please fork and clone the `security-docs` repo.
1520
1. Check out the `main` branch and fetch the latest changes.
1621
1. Check out a new branch and make your changes.
1722
1. Save your changes and open a pull request.
18-
1. Add the [@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs) team and any other appropriate members as reviewers.
23+
1. Add all appropriate Github users as reviewers.
1924
1. Add the appropriate release version label, backport version label if appropriate, and team label to the PR.
2025
1. If your PR changes any [serverless docs content](https://github.com/elastic/security-docs/tree/main/docs/serverless), add the label `ci:doc-build` to generate a preview of the serverless docs on the PR.
2126
1. Once the docs team approves all changes, you can merge it. If a backport version label was added to a PR for stack versions 7.14.0 and newer, mergify will automatically open a backport PR.

docs/AI-for-security/api/anonymization-fields-api-find.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
[[anonymization-fields-api-find]]
22
=== Find anonymization fields
33

4+
.New API Reference
5+
[sidebar]
6+
--
7+
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
8+
--
9+
410
Retrieve a list of anonymization fields that can be included in the LLM context.
511

612
[discrete]

docs/AI-for-security/api/assistant-api-overview.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,10 @@
22
[role="xpack"]
33
== Elastic AI Assistant API
44

5+
.New API Reference
6+
[sidebar]
7+
--
8+
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
9+
--
10+
511
The Elastic AI Assistant API allows you to interact with and manage Elastic AI Assistant.

docs/AI-for-security/api/bulk-actions-anonymization-fields-api.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
[[bulk-actions-anonymization-fields-api]]
22
=== Bulk anonymization field actions
33

4+
.New API Reference
5+
[sidebar]
6+
--
7+
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
8+
--
9+
410
Apply a bulk action (create, update, or delete) to multiple anonymization fields. The bulk action is applied to all anonymization fields that match the filter or to the list of anonymization fields by their IDs.
511

612
[discrete]

docs/AI-for-security/api/bulk-actions-prompts-api.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
[[bulk-actions-prompts-api]]
22
=== Bulk prompt actions
33

4+
.New API Reference
5+
[sidebar]
6+
--
7+
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
8+
--
9+
410
Apply a bulk action (create, update, or delete) to multiple prompts. The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs.
511

612
[discrete]

docs/AI-for-security/api/chat-complete-api.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
[[chat-complete-api]]
22
=== Complete chat
33

4+
.New API Reference
5+
[sidebar]
6+
--
7+
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-ai-assistant-api[AI Assistant APIs].
8+
--
9+
410
The complete chat API allows you to communicate with the configured large language model (LLM) and, if needed, persist the result as a conversation (create new or extend existing).
511

612
[discrete]

0 commit comments

Comments
 (0)