Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore(qol): Make agents more collaborative and not automatically agreeable.

pull/6282/head
Jason Stirnaman 2025-08-05 13:48:07 -05:00 committed by Jason Stirnaman
parent c708bd8658
commit 92210137b2
1 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
.github/copilot-instructions.md vendored
View File

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