Skip to content

Commit a16a1ea

Browse files
authored
Merge branch 'master' into patch-1
2 parents 2b50261 + 64082e9 commit a16a1ea

File tree

1,182 files changed

+146866
-21097
lines changed

Some content is hidden

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

1,182 files changed

+146866
-21097
lines changed

.ci/link-checker/default.lycherc.toml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Lychee link checker configuration
2+
# Generated by link-checker
3+
[lychee]
4+
# Performance settings
5+
6+
# Maximum number of retries for failed checks
7+
8+
max_retries = 3
9+
10+
# Timeout for each link check (in seconds)
11+
timeout = 30
12+
13+
# Maximum number of concurrent checks
14+
max_concurrency = 128
15+
16+
skip_code_blocks = false
17+
18+
# HTTP settings
19+
# Identify the tool to external services
20+
user_agent = "Mozilla/5.0 (compatible; link-checker)"
21+
22+
# Accept these HTTP status codes as valid
23+
accept = [200, 201, 202, 203, 204, 206, 301, 302, 303, 304,
24+
307, 308]
25+
26+
# Skip these URL schemes
27+
scheme = ["file", "mailto", "tel"]
28+
29+
# Exclude patterns (regex supported)
30+
exclude = [
31+
# Localhost URLs
32+
"^https?://localhost",
33+
"^https?://127\\.0\\.0\\.1",
34+
35+
# Common CI/CD environments
36+
"^https?://.*\\.local",
37+
38+
# Example domains used in documentation
39+
"^https?://example\\.(com|org|net)",
40+
41+
# Placeholder URLs from code block filtering
42+
"https://example.com/REMOVED_FROM_CODE_BLOCK",
43+
"example.com/INLINE_CODE_URL",
44+
45+
# URLs that require authentication
46+
"^https?://.*\\.slack\\.com",
47+
"^https?://.*\\.atlassian\\.net",
48+
49+
# GitHub URLs (often fail due to rate limiting and bot
50+
# detection)
51+
"^https?://github\\.com",
52+
53+
# StackExchange network URLs (often block automated requests)
54+
"^https?://.*\\.stackexchange\\.com",
55+
"^https?://stackoverflow\\.com",
56+
"^https?://.*\\.stackoverflow\\.com",
57+
58+
# Docker Hub URLs (rate limiting and bot detection)
59+
"^https?://hub\\.docker\\.com",
60+
61+
# Common documentation placeholders
62+
"YOUR_.*",
63+
"REPLACE_.*",
64+
"<.*>",
65+
]
66+
67+
# Request headers
68+
[headers]
69+
# Add custom headers here if needed
70+
# "Authorization" = "Bearer $GITHUB_TOKEN"
71+
72+
# Cache settings
73+
cache = true
74+
max_cache_age = "1d"
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# Production Link Checker Configuration for InfluxData docs-v2
2+
# Optimized for performance, reliability, and reduced false positives
3+
[lychee]
4+
# Performance settings
5+
6+
# Maximum number of retries for failed checks
7+
8+
max_retries = 3
9+
10+
# Timeout for each link check (in seconds)
11+
timeout = 30
12+
13+
# Maximum number of concurrent checks
14+
max_concurrency = 128
15+
16+
skip_code_blocks = false
17+
18+
# HTTP settings
19+
# Identify the tool to external services
20+
"User-Agent" = "Mozilla/5.0 (compatible; influxdata-link-checker/1.0; +https://github.com/influxdata/docs-v2)"
21+
accept = [200, 201, 202, 203, 204, 206, 301, 302, 303, 304, 307, 308]
22+
23+
# Skip these URL schemes
24+
scheme = ["mailto", "tel"]
25+
26+
# Performance optimizations
27+
cache = true
28+
max_cache_age = "1h"
29+
30+
# Retry configuration for reliability
31+
include_verbatim = false
32+
33+
# Exclusion patterns for docs-v2 (regex supported)
34+
exclude = [
35+
# Localhost URLs
36+
"^https?://localhost",
37+
"^https?://127\\.0\\.0\\.1",
38+
39+
# Common CI/CD environments
40+
"^https?://.*\\.local",
41+
42+
# Example domains used in documentation
43+
"^https?://example\\.(com|org|net)",
44+
45+
# Placeholder URLs from code block filtering
46+
"https://example.com/REMOVED_FROM_CODE_BLOCK",
47+
"example.com/INLINE_CODE_URL",
48+
49+
# URLs that require authentication
50+
"^https?://.*\\.slack\\.com",
51+
"^https?://.*\\.atlassian\\.net",
52+
53+
# GitHub URLs (often fail due to rate limiting and bot
54+
# detection)
55+
"^https?://github\\.com",
56+
57+
# Social media URLs (often block bots)
58+
"^https?://reddit\\.com",
59+
"^https?://.*\\.reddit\\.com",
60+
61+
# StackExchange network URLs (often block automated requests)
62+
"^https?://.*\\.stackexchange\\.com",
63+
"^https?://stackoverflow\\.com",
64+
"^https?://.*\\.stackoverflow\\.com",
65+
66+
# Docker Hub URLs (rate limiting and bot detection)
67+
"^https?://hub\\.docker\\.com",
68+
69+
# InfluxData support URLs (certificate/SSL issues in CI)
70+
"^https?://support\\.influxdata\\.com",
71+
72+
# Common documentation placeholders
73+
"YOUR_.*",
74+
"REPLACE_.*",
75+
"<.*>",
76+
]
77+
78+
# Request headers
79+
[headers]
80+
# Add custom headers here if needed
81+
# "Authorization" = "Bearer $GITHUB_TOKEN"
82+
"Accept" = "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
83+
"Accept-Language" = "en-US,en;q=0.5"
84+
"Accept-Encoding" = "gzip, deflate"
85+
"DNT" = "1"
86+
"Connection" = "keep-alive"
87+
"Upgrade-Insecure-Requests" = "1"
88+
89+
[ci]
90+
# CI-specific settings
91+
92+
[ci.github_actions]
93+
output_format = "json"
94+
create_annotations = true
95+
fail_fast = false
96+
max_annotations = 50 # Limit to avoid overwhelming PR comments
97+
98+
[ci.performance]
99+
# Performance tuning for CI environment
100+
parallel_requests = 32
101+
connection_timeout = 10
102+
read_timeout = 30
103+
104+
# Resource limits
105+
max_memory_mb = 512
106+
max_execution_time_minutes = 10
107+
108+
[reporting]
109+
# Report configuration
110+
include_fragments = false
111+
verbose = false
112+
no_progress = true # Disable progress bar in CI
113+
114+
# Summary settings
115+
show_success_count = true
116+
show_skipped_count = true

.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ LogicalPlan
3131
[Mm]onitor
3232
MBs?
3333
PBs?
34-
Parquet
34+
Parquet|\b\w*-*parquet-\w*\b|\b--\w*parquet\w*\b|`[^`]*parquet[^`]*`
3535
Redoc
3636
SQLAlchemy
3737
SQLAlchemy

.circleci/config.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: 2
1+
version: 2.1
22
jobs:
33
build:
44
docker:
@@ -31,17 +31,17 @@ jobs:
3131
command: cd api-docs && bash generate-api-docs.sh
3232
- run:
3333
name: Inject Flux stdlib frontmatter
34-
command: node ./flux-build-scripts/inject-flux-stdlib-frontmatter.js
34+
command: node ./flux-build-scripts/inject-flux-stdlib-frontmatter.cjs
3535
- run:
3636
name: Update Flux/InfluxDB versions
37-
command: node ./flux-build-scripts/update-flux-versions.js
37+
command: node ./flux-build-scripts/update-flux-versions.cjs
3838
- save_cache:
3939
key: install-{{ .Environment.CACHE_VERSION }}-{{ checksum ".circleci/config.yml" }}
4040
paths:
4141
- /home/circleci/bin
4242
- run:
4343
name: Hugo Build
44-
command: npx hugo --logLevel info --minify --destination workspace/public
44+
command: yarn hugo --environment production --logLevel info --gc --destination workspace/public
4545
- persist_to_workspace:
4646
root: workspace
4747
paths:
@@ -68,7 +68,6 @@ jobs:
6868
when: on_success
6969

7070
workflows:
71-
version: 2
7271
build:
7372
jobs:
7473
- build
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
analyze-api-source:
2+
<product_name> <endpoint_name> <parameter_name>
3+
4+
Analyze source code in the specified repo to determine:
5+
1. HTTP method and endpoint path
6+
2. Parameters for the given endpoint
7+
3. Whether the specified parameter is supported for the given API endpoint
8+
4. Parameter format, valid values, and default behavior
9+
5. Any limitations or quirks of the parameter
10+
11+
For product InfluxDB 3 Core and Enterprise,
12+
Search repo influxdata/influxdb
13+
Search through:
14+
- HTTP endpoint handlers in
15+
influxdb3_server/src/http/
16+
- Parameter structs and deserialization
17+
- Request routing and processing logic
18+
- Type definitions in influxdb3_types/src/
19+
20+
In the output, provide:
21+
- Comparison across v1, v2, and v3 API compatibility
22+
23+
In the output, provide:
24+
Concrete examples of endpoint and parameter usage
25+
Cite specific source code locations.

0 commit comments

Comments
 (0)