@@ -4,6 +4,10 @@ Always follow these instructions first and fallback to additional search and con
4
4
5
5
## Working Effectively
6
6
7
+ ### Collaboration approach
8
+
9
+ Be a critical thinking partner, provide honest feedback, and identify potential issues.
10
+
7
11
### Bootstrap, Build, and Test the Repository
8
12
9
13
Execute these commands in order to set up a complete working environment:
@@ -54,16 +58,18 @@ yarn test:codeblocks:v2
54
58
yarn test:codeblocks:telegraf
55
59
```
56
60
57
- #### Link Validation (takes 10-30 minutes, NEVER CANCEL - set timeout to 45+ minutes):
61
+ #### Link Validation (takes 1-5 minutes):
58
62
59
- ``` bash
60
- # Test all links (very long-running)
61
- yarn test:links
63
+ Runs automatically on pull requests.
64
+ Requires the ** link-checker** binary from the repo release artifacts.
62
65
66
+ ``` bash
63
67
# Test specific files/products (faster)
64
- yarn test:links content/influxdb3/core/** /* .md
65
- yarn test:links:v3
66
- yarn test:links:v2
68
+ # JSON format is required for accurate reporting
69
+ link-checker map content/influxdb3/core/** /* .md \
70
+ | link-checker check \
71
+ --config .ci/link-checker/production.lycherc.toml
72
+ --format json
67
73
```
68
74
69
75
#### Style Linting (takes 30-60 seconds):
@@ -168,24 +174,15 @@ yarn test:links content/example.md
168
174
- ** Package Manager** : Yarn (1.22.22+) with Node.js (20.19.4+)
169
175
- ** Testing Framework** :
170
176
- Pytest with pytest-codeblocks (for code examples)
171
- - Cypress (for link validation and E2E tests)
177
+ - Cypress (for E2E tests)
178
+ - influxdata/docs-link-checker (for link validation)
172
179
- Vale (for style and writing guidelines)
173
180
- ** Containerization** : Docker with Docker Compose
174
181
- ** Linting** : ESLint, Prettier, Vale
175
182
- ** Git Hooks** : Lefthook
176
183
177
184
## Common Tasks and Build Times
178
185
179
- ### Time Expectations (CRITICAL - NEVER CANCEL)
180
-
181
- - ** Dependency installation** : 4 seconds
182
- - ** Hugo static build** : 75 seconds (NEVER CANCEL - timeout: 180+ seconds)
183
- - ** Hugo server startup** : 92 seconds (NEVER CANCEL - timeout: 150+ seconds)
184
- - ** Code block tests** : 5-15 minutes per product (NEVER CANCEL - timeout: 30+ minutes)
185
- - ** Link validation** : 10-30 minutes (NEVER CANCEL - timeout: 45+ minutes)
186
- - ** Style linting** : 30-60 seconds
187
- - ** Docker image build** : 30+ seconds (may fail due to network restrictions)
188
-
189
186
### Network Connectivity Issues
190
187
191
188
In restricted environments, these commands may fail due to external dependency downloads:
0 commit comments