Skip to content

Commit e2c7d72

Browse files
authored
Merge pull request #6282 from influxdata/jts-qol-vscode
chore(qol): Copilot no longer uses instruction settings; it automatic…
2 parents 223e652 + 3f4ad5f commit e2c7d72

File tree

8 files changed

+16
-1824
lines changed

8 files changed

+16
-1824
lines changed

.github/copilot-instructions.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Always follow these instructions first and fallback to additional search and con
44

55
## Working Effectively
66

7+
### Collaboration approach
8+
9+
Be a critical thinking partner, provide honest feedback, and identify potential issues.
10+
711
### Bootstrap, Build, and Test the Repository
812

913
Execute these commands in order to set up a complete working environment:
@@ -54,16 +58,18 @@ yarn test:codeblocks:v2
5458
yarn test:codeblocks:telegraf
5559
```
5660

57-
#### Link Validation (takes 10-30 minutes, NEVER CANCEL - set timeout to 45+ minutes):
61+
#### Link Validation (takes 1-5 minutes):
5862

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.
6265

66+
```bash
6367
# 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
6773
```
6874

6975
#### Style Linting (takes 30-60 seconds):
@@ -168,24 +174,15 @@ yarn test:links content/example.md
168174
- **Package Manager**: Yarn (1.22.22+) with Node.js (20.19.4+)
169175
- **Testing Framework**:
170176
- 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)
172179
- Vale (for style and writing guidelines)
173180
- **Containerization**: Docker with Docker Compose
174181
- **Linting**: ESLint, Prettier, Vale
175182
- **Git Hooks**: Lefthook
176183

177184
## Common Tasks and Build Times
178185

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-
189186
### Network Connectivity Issues
190187

191188
In restricted environments, these commands may fail due to external dependency downloads:

.vscode/settings.json

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,6 @@
1414
},
1515
"vale.valeCLI.config": "${workspaceFolder}/.vale.ini",
1616
"vale.valeCLI.minAlertLevel": "warning",
17-
"github.copilot.chat.codeGeneration.useInstructionFiles": true,
18-
"github.copilot.chat.codeGeneration.instructions": [
19-
{
20-
"file": "${workspaceFolder}/.github/copilot-instructions.md",
21-
}
22-
],
23-
"github.copilot.chat.pullRequestDescriptionGeneration.instructions": [
24-
{
25-
"file": "${workspaceFolder}/.github/copilot-instructions.md",
26-
}
27-
],
2817
"cSpell.words": [
2918
"influxctl"
3019
]

compose.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,6 @@ services:
349349
- --data-dir=/var/lib/influxdb3/data
350350
- --plugin-dir=/var/lib/influxdb3/plugins
351351
environment:
352-
- INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=${INFLUXDB3_ENTERPRISE_LICENSE_EMAIL}
353352
- INFLUXDB3_AUTH_TOKEN=/run/secrets/influxdb3-enterprise-admin-token
354353
volumes:
355354
- type: bind

0 commit comments

Comments
 (0)