Skip to content

Commit c338df6

Browse files
authored
Merge branch 'main' into failure-store-docs
2 parents 86c4c7e + da7fec9 commit c338df6

File tree

2,049 files changed

+12403
-4636
lines changed

Some content is hidden

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

2,049 files changed

+12403
-4636
lines changed

.github/CODEOWNERS

Lines changed: 66 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,67 @@
1-
/.github/ @elastic/doc-leads
2-
/.github/workflows/ @elastic/docs-engineering
1+
# Unless a later match takes precedence, someone on the docs team must review all PRs to this repo
2+
* @elastic/docs
33

4-
/serverless/ @elastic/platform-docs
5-
/serverless/serverless-changelog.asciidoc @elastic/docs
4+
# Templates, workflows, and config
5+
/.github/ @elastic/doc-leads
6+
/.github/workflows/ @elastic/docs-engineering
7+
/acrolinx/ @elastic/doc-leads
8+
9+
# The docs
10+
/cloud-account/ @elastic/admin-docs
11+
/deploy-manage/ @elastic/admin-docs
12+
/explore-analyze/ @elastic/core-docs @elastic/experience-docs
13+
/extend/ @elastic/core-docs
14+
/get-started/ @elastic/core-docs
15+
16+
/manage-data/ @elastic/admin-docs
17+
/manage-data/data-store/ @elastic/admin-docs @elastic/developer-docs
18+
/manage-data/ingest/ @elastic/ingest-docs
19+
20+
/reference/ @elastic/docs
21+
/reference/apm-agents/ @elastic/ingest-docs
22+
/reference/data-analysis/ @elastic/docs
23+
/reference/data-analysis/observability/ @elastic/experience-docs
24+
/reference/data-analysis/kibana/ @elastic/experience-docs
25+
/reference/data-analysis/machine-learning/ @elastic/developer-docs
26+
/reference/data-analysis/observability/ @elastic/experience-docs
27+
/reference/elasticsearch/clients/ @elastic/developer-docs
28+
/reference/fleet/ @elastic/ingest-docs
29+
/reference/glossary/ @elastic/docs
30+
/reference/ingestion-tools/ @elastic/ingest-docs
31+
/reference/observability/ @elastic/experience-docs
32+
/reference/search/ @elastic/developer-docs
33+
/reference/security/ @elastic/experience-docs
34+
35+
/release-notes/ @elastic/docs
36+
37+
/release-notes/apm-agents/ @elastic/ingest-docs
38+
/release-notes/elastic-cloud-serverless/ @elastic/admin-docs
39+
/release-notes/elastic-observability/ @elastic/ski-docs
40+
/release-notes/elastic-security/ @elastic/ski-docs
41+
/release-notes/elasticsearch-clients/ @elastic/developer-docs
42+
/release-notes/fleet-elastic-agent/ @elastic/ingest-docs
43+
/release-notes/intro/ @elastic/docs
44+
45+
/solutions/ @elastic/experience-docs @elastic/developer-docs
46+
/solutions/observability/ @elastic/experience-docs
47+
/solutions/observability/get-started/ @elastic/ski-docs
48+
/solutions/search/ @elastic/developer-docs
49+
/solutions/security/ @elastic/experience-docs
50+
/solutions/security/get-started/ @elastic/ingest-docs @elastic/experience-docs
51+
/solutions/security/cloud/ @elastic/ingest-docs
52+
53+
/troubleshoot/ @elastic/docs
54+
/troubleshoot/deployments/ @elastic/admin-docs
55+
/troubleshoot/elasticsearch/ @elastic/admin-docs
56+
/troubleshoot/ingest/ @elastic/ingest-docs
57+
/troubleshoot/kibana/ @elastic/admin-docs @elastic/experience-docs
58+
/troubleshoot/monitoring/ @elastic/admin-docs @elastic/experience-docs
59+
/troubleshoot/observability/ @elastic/ski-docs
60+
/troubleshoot/security/ @elastic/ski-docs
61+
62+
# Raw migrated files
63+
/raw-migrated-files/ @elastic/docs
64+
65+
# Legacy serverless docs
66+
/serverless/ @elastic/admin-docs
67+
/serverless/serverless-changelog.asciidoc @elastic/docs

.github/ISSUE_TEMPLATE/community-request.yaml renamed to .github/ISSUE_TEMPLATE/a-community-request.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
name: "Community documentation request"
2-
description: Request a documentation change or enhancement.
3-
title: "[Request]: "
4-
labels: ["Request", "community"]
2+
description: An issue template for non-Elastic employees to request changes to the documentation.
3+
title: "[Community]: "
4+
labels: ["community"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Hi 👋. Thanks for taking the time to fill out this request!
10-
This form will create an issue that Elastic's docs team will triage and prioritize.
11-
You can also open a PR instead.
9+
This issue template is for non-Elastic employees to request changes to the documentation. **If you are an Elastic employee, please use the internal issue template instead.**
10+
11+
This form will create an issue that Elastic's docs team will triage and prioritize. You can also open a PR instead. Thanks for taking the time to fill out this request!
1212
- type: textarea
1313
id: link
1414
attributes:

.github/ISSUE_TEMPLATE/internal-request.yaml renamed to .github/ISSUE_TEMPLATE/b-internal-request.yaml

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
name: "Internal documentation request (Elastic employees)"
2-
description: Request a documentation change or enhancement for any supported release.
3-
title: "[REQUEST]: "
4-
labels: ["request", "Team:Docs"]
2+
description: An issue template for Elastic employees to request improvements, additions, or changes to the documentation.
3+
title: "[Internal]: "
54
body:
65
- type: markdown
76
attributes:
@@ -69,6 +68,14 @@ body:
6968
default: 0
7069
validations:
7170
required: true
71+
- type: input
72+
id: release-serverless
73+
attributes:
74+
label: Serverless release
75+
description: When do you expect the feature to be promoted and available in the _**serverless production environment**_?
76+
placeholder: The week of April 1, 2024
77+
validations:
78+
required: true
7279
- type: dropdown
7380
id: collaboration
7481
attributes:

.github/ISSUE_TEMPLATE/api-feedback.yaml renamed to .github/ISSUE_TEMPLATE/c-api-feedback.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: "API docs feedback"
22
description: Tell us about your experience with Elastic API documentation.
3-
title: "[Feedback]: "
4-
labels: ["feedback", "community"]
3+
title: "[API]: "
4+
labels: ["api-feedback"]
55
body:
66
- type: markdown
77
attributes:
File renamed without changes.

.github/ISSUE_TEMPLATE/issue-report.yaml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
name: "Docs issue"
2-
description: Report documentation issues such as inaccuracies, broken links, typos, or missing information.
3-
title: "[Issue]: "
4-
labels: ["triage"]
1+
name: "Website issue"
2+
description: This issue template should only be used when navigating directly from elastic.co.
3+
title: "[Website]: "
4+
labels: ["source:web"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Hi 👋. Thanks for taking the time to fill out this issue report!
10-
This form will create an issue that Elastic's docs team will triage and prioritize.
11-
You can also open a PR instead.
9+
Hi 👋. Thanks for taking the time to fill out this issue report! This form will create an issue that Elastic's docs team will triage and prioritize. You can also open a PR instead.
1210
- type: dropdown
1311
attributes:
1412
label: Type of issue

.github/workflows/add-to-board.yml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ jobs:
1212
route:
1313
runs-on: ubuntu-latest
1414
if: |
15+
github.event.label.name == 'team:Ingest' ||
16+
github.event.label.name == 'team:Experience' ||
17+
github.event.label.name == 'team:Admin' ||
18+
github.event.label.name == 'team:Developer' ||
1519
github.event.label.name == 'team:DocsEng' ||
1620
github.event.label.name == 'team:Obs' ||
1721
github.event.label.name == 'team:Platform' ||
@@ -21,12 +25,16 @@ jobs:
2125
env:
2226
PROJECT_ID_MAP: |
2327
{
24-
"team:DocsEng": "1625",
25-
"team:Obs": "649",
26-
"team:Platform": "1232",
27-
"team:Projects": "1415",
28-
"team:Search": "726",
29-
"team:Security": "1034"
28+
"team:Ingest": "649",
29+
"team:Experience": "1034",
30+
"team:Admin": "1927",
31+
"team:Developer": "726",
32+
"team:DocsEng": "1625",
33+
"team:Obs": "649",
34+
"team:Platform": "1232",
35+
"team:Projects": "1415",
36+
"team:Search": "726",
37+
"team:Security": "1034"
3038
}
3139
steps:
3240
- name: Remove needs-team label
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: "Docs preview comment"
2+
3+
on:
4+
pull_request_target:
5+
types: [opened, reopened, synchronize]
6+
7+
permissions:
8+
contents: read
9+
issues: write
10+
pull-requests: write
11+
12+
jobs:
13+
preview-links:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Comment preview links for changed docs
17+
uses: actions/github-script@v7
18+
with:
19+
github-token: ${{ secrets.GITHUB_TOKEN }}
20+
script: |
21+
const pr = context.payload.pull_request;
22+
const prNum = pr.number;
23+
const owner = context.repo.owner;
24+
const repo = context.repo.repo;
25+
const base = `https://docs-v3-preview.elastic.dev/${owner}/${repo}/pull/${prNum}`;
26+
27+
// 1) List all files in this PR
28+
const { data: files } = await github.rest.pulls.listFiles({
29+
owner, repo, pull_number: prNum
30+
});
31+
32+
// 2) Filter to only added/modified .md files (skip removed and _snippets/)
33+
const links = files
34+
.filter(f =>
35+
f.status !== 'removed' &&
36+
/\.md$/i.test(f.filename) &&
37+
!/(^|\/)_snippets\//i.test(f.filename)
38+
)
39+
.map(f => {
40+
let p = f.filename.replace(/\/index\.md$/i, '/');
41+
if (p === f.filename) p = p.replace(/\.md$/i, '');
42+
return `- [\`${f.filename}\`](${base}/${p})`;
43+
});
44+
45+
if (!links.length) return; // nothing to do
46+
47+
// 3) Build the comment body
48+
const body = [
49+
"🔍 **Preview links for changed docs:**",
50+
"",
51+
...links,
52+
"",
53+
"🔔 *The preview site may take up to **3 minutes** to finish building. These links will become live once it completes.*"
54+
].join("\n");
55+
56+
// 4) Post or update a single bot comment
57+
const { data: comments } = await github.rest.issues.listComments({
58+
owner, repo, issue_number: prNum
59+
});
60+
const existing = comments.find(c =>
61+
c.user.type === 'Bot' &&
62+
c.body.startsWith("🔍 **Preview links for changed docs:**")
63+
);
64+
65+
if (existing) {
66+
await github.rest.issues.updateComment({
67+
owner, repo,
68+
comment_id: existing.id,
69+
body
70+
});
71+
} else {
72+
await github.rest.issues.createComment({
73+
owner, repo,
74+
issue_number: prNum,
75+
body
76+
});
77+
}

archive.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: archive
3-
description: Browse the archive for legacy Elastic products and documentation. Archive documentation is unmaintained and may be out-of-date.
3+
description: Browse the archive for legacy Elastic products and documentation.
4+
Archive documentation is unmaintained and may be out-of-date.
45
---
56

67
# Documentation archive

cloud-account/add-a-login-method.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ applies_to:
55
serverless: all
66
deployment:
77
ess: all
8+
products:
9+
- id: cloud-hosted
810
---
911

1012
# Add a login method [ec-change-login-method]

0 commit comments

Comments
 (0)