Skip to content

Commit 24a877a

Browse files
authored
Merge branch 'master' into brett.blue/config-visibility
2 parents 10368bd + 89f49b1 commit 24a877a

File tree

4,087 files changed

+327160
-212639
lines changed

Some content is hidden

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

4,087 files changed

+327160
-212639
lines changed

.claude/settings.local.json

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

.github/CODEOWNERS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ data/private_action_runner_version.json @Datadog/documenta
7676
# Serverless
7777

7878
/content/en/serverless/ @DataDog/serverless @DataDog/documentation
79-
/layouts/shortcodes/latest-lambda-layer-version.html @DataDog/documentation
79+
/layouts/shortcodes/latest-lambda-layer-version.html @DataDog/serverless @DataDog/serverless-onboarding-and-enablement @DataDog/documentation
8080

8181
# Database Management
8282
/content/en/database_monitoring/ @DataDog/database-monitoring @DataDog/documentation
@@ -139,7 +139,7 @@ content/en/real_user_monitoring/error_tracking/kotlin_multiplatform.md @Datado
139139
# Browser SDK
140140
content/en/real_user_monitoring/browser/ @Datadog/rum-browser @DataDog/documentation
141141
content/en/real_user_monitoring/guide/ @Datadog/rum-browser @DataDog/documentation
142-
content/en/real_user_monitoring/session_replay/browser @Datadog/rum-browser @DataDog/documentation
142+
content/en/session_replay/browser @Datadog/rum-browser @DataDog/documentation
143143
content/en/logs/log_collection/javascript.md @Datadog/rum-browser @DataDog/documentation
144144
content/en/logs/error_tracking/browser_and_mobile.md @Datadog/rum-browser @DataDog/documentation
145145
content/en/real_user_monitoring/error_tracking/browser.md @Datadog/rum-browser @DataDog/documentation

.github/workflows/bump_synthetics_worker_version.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ jobs:
7171
owner: context.repo.owner,
7272
repo: context.repo.repo,
7373
title: "(Automated) Bump version",
74-
body: "### Merge instructions\n- [x] Please merge after reviewing",
74+
body: "### Merge instructions\n- **Please merge this PR after approving!**",
7575
head: "automatic-version-update/synthetics-worker",
7676
base: "master",
7777
maintainer_can_modify: true
78-
})
78+
})

.github/workflows/codeowner_review_status.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,10 @@ jobs:
6060
pull_number: number,
6161
});
6262
63-
// Track latest review state per user
63+
// Track latest review state per user (ignore commented state)
6464
const latestReviews = new Map();
6565
reviews.forEach(review => {
66+
if (review.state === 'COMMENTED') return;
6667
const existing = latestReviews.get(review.user.login);
6768
if (!existing || review.submitted_at > existing.submitted_at) {
6869
latestReviews.set(review.user.login, review);
@@ -200,4 +201,4 @@ jobs:
200201
description: statusDescription,
201202
context: 'Documentation Team Approval'
202203
});
203-
console.log(`Created commit status: ${statusState} - ${statusDescription}`);
204+
console.log(`Created commit status: ${statusState} - ${statusDescription}`);

.github/workflows/datadog-static-analysis.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,9 @@ jobs:
1717
persist-credentials: false
1818
- name: Check code meets quality and security standards
1919
id: datadog-static-analysis
20-
uses: DataDog/datadog-static-analyzer-github-action@2707598b1182dce1d1792186477b5b4132338e1c # v1.2.3
20+
uses: DataDog/datadog-static-analyzer-github-action@8340f18875fcefca86844b5f947ce2431387e552 # v3.0.0
2121
with:
2222
dd_api_key: ${{ secrets.DD_API_KEY }}
2323
dd_app_key: ${{ secrets.DD_APP_KEY }}
24-
dd_service: documentation
25-
dd_env: ci
2624
dd_site: datadoghq.com
2725
cpu_count: 2

.gitignore

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ _vendor/
99

1010
# htmltest tmp files
1111
bin/htmltest
12+
htmltest_report.txt
1213
tmp
1314

1415
# Ignore generated examples
@@ -156,14 +157,17 @@ content/en/static_analysis/github_actions.md
156157
content/en/static_analysis/circleci_orbs.md
157158
content/en/static_analysis/rules/
158159

160+
# containers - kubernetes
161+
content/en/containers/kubernetes/kubectl_plugin.md
162+
159163
# containers - datadog-operator
160164
content/en/containers/datadog_operator/advanced_install.md
161165
content/en/containers/datadog_operator/configuration.md
162166
content/en/containers/datadog_operator/custom_check.md
163167
content/en/containers/datadog_operator/data_collected.md
164-
content/en/containers/datadog_operator/kubectl_plugin.md
165168
content/en/containers/datadog_operator/secret_management.md
166169
content/en/containers/guide/v2alpha1_migration.md
170+
content/en/containers/datadog_operator/kubectl_plugin.md
167171

168172
# serverless
169173
content/en/serverless/libraries_integrations/plugin.md
@@ -311,9 +315,14 @@ static/cdocs
311315
content/en/**/*.ast.json
312316
layouts/shortcodes/mdoc/en/**/*.ast.json
313317
*.tempAst.json
318+
.cdocs_temp
314319

315320
# Cursor editor configuration
316321
.cursor/
317322

318-
# Generated file for LLMs
323+
324+
# Deprecated generated file for LLMs (keep so it's not merged back in)
319325
static/llms.txt
326+
327+
# AI
328+
.claude/*local*

.husky/check-circular-aliases.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def get_staged_files():
5757
"""Get staged markdown files or all files if no staged files."""
5858
try:
5959
result = subprocess.run(
60-
['git', 'diff', '--cached', '--name-only', '--diff-filter=ACM'],
60+
['git', 'diff', '--cached', '--name-only', '--diff-filter=ACMR'],
6161
capture_output=True,
6262
text=True,
6363
check=True
@@ -76,14 +76,20 @@ def check_circular_aliases():
7676
"""Check for circular aliases in markdown files."""
7777
errors = []
7878
staged_files = get_staged_files()
79-
79+
8080
for file_path in staged_files:
81-
if not file_path or not os.path.exists(file_path):
81+
if not file_path:
8282
continue
83-
83+
8484
try:
85-
with open(file_path, 'r', encoding='utf-8') as f:
86-
content = f.read()
85+
# Read the STAGED version of the file, not the working directory version
86+
result = subprocess.run(
87+
['git', 'show', f':{file_path}'],
88+
capture_output=True,
89+
text=True,
90+
check=True
91+
)
92+
content = result.stdout
8793

8894
frontmatter = parse_frontmatter(content)
8995
aliases = frontmatter.get('aliases', [])

.vale.ini

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Datadog.Trademarks = NO
1010
BlockIgnores = (?s) *({{< ?code-block [^>]* >}}.*?{{< ?/ ?code-block >}}), \
1111
(?s) *({{< ?img [^>]*>}}), \
1212
(?s) *({{< ?(w|/w)hatsnext [^>]*>}}), \
13-
(?s) *({{< ?(n|/n)extlink [^>]*>}})
13+
(?s) *({{< ?(n|/n)extlink [^>]*>}}), \
14+
(?s) *({%\s*if\s+[^%]*%}), \
15+
(?s) *({%\s*partial\s+[^%]*\/%})
1416
TokenIgnores = ({{< ?site-region [^>]* >}})
1517

1618
[*.html]

.vscode/markdoc.code-snippets

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"scope": "markdoc",
1111
"prefix": ";;callout",
1212
"body": [
13-
"{% callout src=\"${1:https://www.example.com}\" header=\"${2:Join the Preview!}\" btn_hidden=${3|false,true|} %}",
13+
"{% callout url=\"${1:https://www.example.com}\" header=\"${2:Join the Preview!}\" btn_hidden=${3|false,true|} %}",
1414
"${4:Callout content goes here.}",
1515
"{% /callout %}"
1616
],
@@ -28,6 +28,17 @@
2828
"description": "Markdoc code block with attributes and tabstop choices"
2929
},
3030

31+
"Collapse content": {
32+
"scope": "markdoc",
33+
"prefix": ";;collapse-content",
34+
"body": [
35+
"{% collapse-content title=\"${1:Your title}\" level=\"${2|h4,h1,h2,h3,h5|}\" expanded=${3|true,false|} id=\"${4:unique-id}\" %}",
36+
"${5:Collapsible content goes here.}",
37+
"{% /collapse-content %}"
38+
],
39+
"description": "Markdoc collapse block with customizable label"
40+
},
41+
3142
"Definition list": {
3243
"scope": "markdoc",
3344
"prefix": ";;list",
@@ -132,6 +143,13 @@
132143
"description": "Markdoc tabs block with two labeled tabs"
133144
},
134145

146+
"Tooltip": {
147+
"scope": "markdoc",
148+
"prefix": ";;tooltip",
149+
"body": ["{% tooltip contents=\"${1:Popup text}\" %}", "${2:display text}", "{% /tooltip %}"],
150+
"description": "Markdoc tooltip block with customizable content"
151+
},
152+
135153
"Check mark": {
136154
"scope": "markdoc",
137155
"prefix": ";;check",

CLAUDE.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,48 @@ CRITICAL: Always use format `<name>/<description>` with forward slash. Without t
6868
- No branch preview will be generated
6969
- CI will fail
7070

71+
### PR Checklist
72+
- Leave the "Ready for merge" checkbox unchecked unless explicitly requested.
73+
74+
### PR Title Format
75+
Use the Jira ticket key in square brackets: `[DOCS-XXXXX] Brief description`
76+
77+
### PR Description Template
78+
```
79+
<!-- *Note: Please remember to review the Datadog Documentation [Contribution Guidelines](https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md) if you have not yet done so.* -->
80+
81+
### What does this PR do? What is the motivation?
82+
83+
Fixes DOCS-XXXXX
84+
85+
[Brief description of changes]
86+
87+
### Merge instructions
88+
89+
Merge readiness:
90+
- [ ] Ready for merge
91+
92+
### Additional notes
93+
94+
```
95+
96+
### Pre-commit Checklist
97+
Before committing changes, run Vale to check style compliance:
98+
```bash
99+
vale /path/to/changed/file.md
100+
```
101+
Fix any warnings before committing. Common issues:
102+
- "once you" → "after you"
103+
- "fine-tune" → "customize"
104+
- "ensure" → "helps ensure"
105+
- Remove filler words: easy, simple, just, please, very
106+
107+
### Commit Messages
108+
- Keep messages concise and descriptive
109+
110+
### Jira Workflow
111+
- When a PR is created, transition the Jira ticket to **Reviewable** status (transition ID: 101)
112+
71113
### Content Guidelines
72114
Follow the CONTRIBUTING.md style guide:
73115
- Use American English (en_US)
@@ -76,6 +118,31 @@ Follow the CONTRIBUTING.md style guide:
76118
- Use imperative voice for instructions
77119
- Don't edit translated content directly (managed externally)
78120

121+
### Style Rules (from datadog-vale)
122+
The full Vale linter rules are at https://github.com/DataDog/datadog-vale. Key substitutions:
123+
124+
| Don't use | Use instead |
125+
|-----------|-------------|
126+
| once you/once the | after you/after the |
127+
| fine-tune | customize, optimize, or refine |
128+
| ensure/ensures | helps, helps ensure |
129+
| leverage | use, apply, take advantage of |
130+
| utilize | use |
131+
| in order to | to |
132+
| easy/easily | (remove) |
133+
| simple/simply | (remove) |
134+
| just | (remove) |
135+
| please | (remove) |
136+
| via | with, through |
137+
| Note that | **Note**: |
138+
| drill down/into | examine, investigate, analyze |
139+
| refer to/visit | see, read, follow |
140+
| obvious/obviously | (remove) |
141+
| seamless/seamlessly | (remove) |
142+
| quick/quickly | (remove) |
143+
144+
Avoid temporal words: currently, now, will, won't
145+
79146
## Hugo-Specific Details
80147

81148
### Shortcodes

0 commit comments

Comments
 (0)