fix(content): use text+lp fences for line protocol syntax examples - #7705
Conversation
Vale Style Check Results
Warnings (4)
✅ Check passed |
🔗 Link Check Results — Link Check Bot❌ 3 broken link(s) found — fix them before merging.
Broken Links
|
| Source File | URL | Issue |
|---|---|---|
content/enterprise_influxdb/v1/guides/write_data/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/example/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/cloud/reference/syntax/line-protocol/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v2/reference/syntax/line-protocol/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud-dedicated/reference/syntax/line-protocol/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud-serverless/reference/syntax/line-protocol/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/reference/syntax/line-protocol/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/clustered/reference/syntax/line-protocol/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/core/reference/line-protocol/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/line-protocol/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
Full details: workflow run summary and artifact. Last updated: 2026-08-25 21:59:23 UTC
e89cda3 to
d9bbe3c
Compare
|
Converting these blocks from What's lost: // Javascript / Flux specific styles (duration and time values)
.language-js {
.mi + .nx, .mf + .nx { color: $article-code-accent5; }
}This incidentally colorized line protocol's integer/uinteger suffixes ( Not a template bug — nothing breaks, no build/render error. |
Fixed with: |
There was a problem hiding this comment.
I think there's a lot more we could do for syntax highlighting line protocol, but it's probably beyond this PR and may even be worth contributing to Chroma upstream. I think this is good enough for now.
There was a problem hiding this comment.
I think there's a lot more we could do for syntax highlighting line protocol, but it's probably beyond this PR and may even be worth contributing to Chroma upstream. I think this is good enough for now.
My thoughts exactly. I considered starting the Chroma work, but it'll have to wait for now.
#7678 and #5821 fixed the misleading `js`/`//` comment syntax in the line protocol "Syntax" block, but relabeled it `python`, which is still not what the block is (a placeholder grammar, not runnable Python or JS). Split each occurrence into a `text` fence for the placeholder syntax and a standalone `lp` fence for the real example, matching this repo's line-protocol fence convention. Also fixed the several other `js`/`sh`-tagged blocks in the same two shared files that are real, standalone line protocol (not templates) to use `lp`, since they were failing codeblock lint as invalid JavaScript. PR #5821 targeted content/influxdb/v2/reference/syntax/line-protocol.md, which is now a stub whose body is sourced from content/shared/influxdb-v2/reference/syntax/line-protocol.md; applied its intent to the shared file instead. Co-authored-by: MaximAL <almaximal@gmail.com>
What changed - Add a Hugo lp render hook with field-family highlighting and safe malformed-input fallback. - Add a blocking lp code-block validator and unit, extractor, CLI, and Cypress coverage. - Document lp fence validation and regenerate instruction adapters. Why Line protocol examples need syntax-aware rendering and CI validation while preserving escaped source text. Impact The linter now fails invalid lp fences unless they explicitly use lint="false". Verification - yarn test:lint-codeblocks - yarn test:render-regression - yarn build:agent:instructions - yarn validate:agent-instructions
e691ae2 to
de35d65
Compare
What changed
##7678 and Change comments in line protocol syntax to be self-descriptive##5821.Why
Line protocol examples need syntax-aware rendering and validation. The former js and sh labels incorrectly represented line protocol as executable JavaScript or shell code, and the new lp support prevents malformed examples from silently reaching the docs.
Impact
Docs rendering now gives lp fences dedicated syntax markup. CI rejects malformed lp fences unless they are explicitly exempted. No runtime dependency or product behavior changes.
Verification
Closes #7678
Closes #5821