Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 30 additions & 34 deletions .ci/link-checker/default.lycherc.toml
Original file line number Diff line number Diff line change
@@ -1,38 +1,36 @@
# Lychee link checker configuration
# Generated by link-checker
# Updated for link-checker v1.3.0 with severity-based classification
#
# With severity levels, we no longer need to exclude sites that return:
# - 403/401/429 (classified as "info" - shown but don't fail CI)
# - 5xx/timeout (classified as "warning" - shown but don't fail CI)
# Only 404/410/DNS failures are classified as "error" and fail CI.

[lychee]
# Performance settings

# Maximum number of retries for failed checks

max_retries = 3

# Timeout for each link check (in seconds)
timeout = 30

# Maximum number of concurrent checks
max_concurrency = 128

skip_code_blocks = false

# HTTP settings
# Identify the tool to external services
user_agent = "Mozilla/5.0 (compatible; link-checker)"

# Accept these HTTP status codes as valid
accept = [200, 201, 202, 203, 204, 206, 301, 302, 303, 304,
307, 308]
# Accept these HTTP status codes as valid (2xx and redirects)
accept = [200, 201, 202, 203, 204, 206, 301, 302, 303, 304, 307, 308]

# Skip these URL schemes
scheme = ["file", "mailto", "tel"]

# Exclude patterns (regex supported)
# NOTE: With v1.3.0 severity classification, we only need to exclude:
# - Non-HTTP URLs (localhost, local networks)
# - Placeholder/example URLs
# - Known false positives (not HTTP status related)
exclude = [
# Localhost URLs
# Localhost and local network URLs
"^https?://localhost",
"^https?://127\\.0\\.0\\.1",

# Common CI/CD environments
"^https?://.*\\.local",

# Example domains used in documentation
Expand All @@ -42,22 +40,6 @@ exclude = [
"https://example.com/REMOVED_FROM_CODE_BLOCK",
"example.com/INLINE_CODE_URL",

# URLs that require authentication
"^https?://.*\\.slack\\.com",
"^https?://.*\\.atlassian\\.net",

# GitHub URLs (often fail due to rate limiting and bot
# detection)
"^https?://github\\.com",

# StackExchange network URLs (often block automated requests)
"^https?://.*\\.stackexchange\\.com",
"^https?://stackoverflow\\.com",
"^https?://.*\\.stackoverflow\\.com",

# Docker Hub URLs (rate limiting and bot detection)
"^https?://hub\\.docker\\.com",

# Common documentation placeholders
"YOUR_.*",
"REPLACE_.*",
Expand All @@ -67,8 +49,22 @@ exclude = [
# Request headers
[headers]
# Add custom headers here if needed
# "Authorization" = "Bearer $GITHUB_TOKEN"

# Cache settings
cache = true
max_cache_age = "1d"
max_cache_age = "1d"

# Severity classification (link-checker v1.3.0+)
# These settings control which HTTP status codes fail CI vs show as warnings/info
[severity]
# Error codes fail CI - genuine broken links
error_codes = [404, 410]

# Warning codes are shown but don't fail CI - transient issues
warning_codes = [500, 502, 503, 504]

# Info codes are low priority - access restrictions, bot protection
info_codes = [401, 403, 429]

# Set to true to treat warnings as errors (stricter validation)
strict = false
95 changes: 31 additions & 64 deletions .ci/link-checker/production.lycherc.toml
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
# Production Link Checker Configuration for InfluxData docs-v2
# Optimized for performance, reliability, and reduced false positives
# Updated for link-checker v1.3.0 with severity-based classification
#
# With severity levels, we no longer need to exclude sites that return:
# - 403/401/429 (classified as "info" - shown but don't fail CI)
# - 5xx/timeout (classified as "warning" - shown but don't fail CI)
# Only 404/410/DNS failures are classified as "error" and fail CI.

[lychee]
# Performance settings

# Maximum number of retries for failed checks

max_retries = 3

# Timeout for each link check (in seconds)
timeout = 30

# Maximum number of concurrent checks
max_concurrency = 128

skip_code_blocks = false

# HTTP settings
# Identify the tool to external services
"User-Agent" = "Mozilla/5.0 (compatible; influxdata-link-checker/1.0; +https://github.com/influxdata/docs-v2)"
"User-Agent" = "Mozilla/5.0 (compatible; influxdata-link-checker/1.3; +https://github.com/influxdata/docs-v2)"
accept = [200, 201, 202, 203, 204, 206, 301, 302, 303, 304, 307, 308]

# Skip these URL schemes
Expand All @@ -31,12 +28,15 @@ max_cache_age = "1h"
include_verbatim = false

# Exclusion patterns for docs-v2 (regex supported)
# NOTE: With v1.3.0 severity classification, we only need to exclude:
# - Non-HTTP URLs (localhost, local networks)
# - Placeholder/example URLs
# - Known false positives (not HTTP status related)
# - CI-specific workarounds
exclude = [
# Localhost URLs
# Localhost and local network URLs
"^https?://localhost",
"^https?://127\\.0\\.0\\.1",

# Common CI/CD environments
"^https?://.*\\.local",

# Example domains used in documentation
Expand All @@ -46,51 +46,6 @@ exclude = [
"https://example.com/REMOVED_FROM_CODE_BLOCK",
"example.com/INLINE_CODE_URL",

# URLs that require authentication
"^https?://.*\\.slack\\.com",
"^https?://.*\\.atlassian\\.net",

# GitHub URLs (often fail due to rate limiting and bot
# detection)
"^https?://github\\.com",

# Social media URLs (often block bots)
"^https?://reddit\\.com",
"^https?://.*\\.reddit\\.com",

# StackExchange network URLs (often block automated requests)
"^https?://.*\\.stackexchange\\.com",
"^https?://stackoverflow\\.com",
"^https?://.*\\.stackoverflow\\.com",

# Docker Hub URLs (rate limiting and bot detection)
"^https?://hub\\.docker\\.com",

# InfluxData support URLs (certificate/SSL issues in CI)
"^https?://support\\.influxdata\\.com",
"^https?://influxdata\\.com/slack",

# NSSM download URLs (403 errors for automated requests)
"^https?://nssm\\.cc/download",

# AI platforms (often block automated requests)
"^https?://claude\\.ai",
"^https?://.*\\.claude\\.ai",

# Microsoft Learn documentation (bot detection/rate limiting)
"^https?://learn\\.microsoft\\.com",
"^https?://.*\\.microsoft\\.com/.*",

# Dremio download URLs (403 errors for automated requests)
"^https?://download\\.dremio\\.com",

# Scarf analytics tracking pixels (certificate/network errors)
"^https?://static\\.scarf\\.sh",

# Grafana documentation (bot detection/rate limiting)
"^https?://grafana\\.com",
"^https?://.*\\.grafana\\.com",

# Production site URLs (when testing locally, these should be relative)
# This excludes canonical URLs and other absolute production URLs
# TODO: Remove after fixing canonical URL generation or link-checker domain replacement
Expand All @@ -100,7 +55,6 @@ exclude = [
# link-checker converts /path/to/page#fragment to file:///path/to/page#fragment
# but the actual file is at /path/to/page/index.html, causing false fragment errors
# TODO: Remove after fixing link-checker to handle Hugo pretty URLs with fragments
# See: https://github.com/influxdata/docs-tooling/issues/XXX
"^file://.*#",

# Common documentation placeholders
Expand All @@ -109,17 +63,30 @@ exclude = [
"<.*>",
]

# Request headers
# Request headers (help avoid bot detection on some sites)
[headers]
# Add custom headers here if needed
# "Authorization" = "Bearer $GITHUB_TOKEN"
"Accept" = "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
"Accept-Language" = "en-US,en;q=0.5"
"Accept-Encoding" = "gzip, deflate"
"DNT" = "1"
"Connection" = "keep-alive"
"Upgrade-Insecure-Requests" = "1"

# Severity classification (link-checker v1.3.0+)
# These settings control which HTTP status codes fail CI vs show as warnings/info
[severity]
# Error codes fail CI - genuine broken links
error_codes = [404, 410]

# Warning codes are shown but don't fail CI - transient issues
warning_codes = [500, 502, 503, 504]

# Info codes are low priority - access restrictions, bot protection
info_codes = [401, 403, 429]

# Set to true to treat warnings as errors (stricter validation)
strict = false

[ci]
# CI-specific settings

Expand Down Expand Up @@ -147,4 +114,4 @@ no_progress = true # Disable progress bar in CI

# Summary settings
show_success_count = true
show_skipped_count = true
show_skipped_count = true
2 changes: 1 addition & 1 deletion .github/workflows/pr-link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ jobs:
curl -L -H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
-o link-checker-info.json \
"https://api.github.com/repos/influxdata/docs-v2/releases/tags/link-checker-v1.2.5"
"https://api.github.com/repos/influxdata/docs-v2/releases/tags/link-checker-v1.3.0"

# Extract download URL for linux binary
DOWNLOAD_URL=$(jq -r '.assets[] | select(.name | test("link-checker.*linux")) | .url' link-checker-info.json)
Expand Down
16 changes: 8 additions & 8 deletions content/influxdb3/cloud-serverless/sign-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ complete the following steps:

Click the following button to download and install `influx` CLI for macOS.

<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-darwin-amd64.tar.gz" download>influx CLI (macOS)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64.tar.gz" download>influx CLI (macOS)</a>

#### Step 2: Unpackage the influx binary

Expand All @@ -149,7 +149,7 @@ or run the following command in a macOS command prompt application such

```sh
# Unpackage contents to the current working directory
tar zxvf ~/Downloads/influxdb2-client-2.7.5-darwin-amd64.tar.gz
tar zxvf ~/Downloads/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64.tar.gz
```

#### Step 3: (Optional) Place the binary in your $PATH
Expand All @@ -161,7 +161,7 @@ prefix the executable with `./` to run in place. If the binary is on your $PATH,

```sh
# Copy the influx binary to your $PATH
sudo cp influxdb2-client-2.7.5-darwin-amd64/influx /usr/local/bin/
sudo cp influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64/influx /usr/local/bin/
```

> [!Note]
Expand Down Expand Up @@ -204,16 +204,16 @@ To see all available `influx` commands, type `influx -h` or check out [influx -

Click one of the following buttons to download and install the `influx` CLI appropriate for your chipset.

<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-linux-amd64.tar.gz" download >influx CLI (amd64)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-linux-arm64.tar.gz" download >influx CLI (arm)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz" download >influx CLI (amd64)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64.tar.gz" download >influx CLI (arm)</a>

#### Step 2: Unpackage the influx binary

**Note:** The commands below are examples. Adjust the file names, paths, and utilities to your own needs.

```sh
# Unpackage contents to the current working directory
tar xvfz influxdb2-client-2.7.5-linux-amd64.tar.gz
tar xvfz influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz
```

#### Step 3: (Optional) Place the binary in your $PATH
Expand All @@ -225,7 +225,7 @@ prefix the executable with `./` to run in place. If the binary is on your $PATH,

```sh
# Copy the influx and influxd binary to your $PATH
sudo cp influxdb2-client-2.7.5-linux-amd64/influx /usr/local/bin/
sudo cp influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64/influx /usr/local/bin/
```

> [!Note]
Expand Down Expand Up @@ -263,7 +263,7 @@ To see all available `influx` commands, type `influx -h` or check out [influx -

Click the following button to download and install `influx` CLI for Windows.

<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-windows-amd64.zip" download>influx CLI (Windows)</a>
<a class="btn download" href="https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-windows-amd64.zip" download>influx CLI (Windows)</a>

#### Step 2: Expand the downloaded archive

Expand Down
Loading
Loading