docs: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month ago
Release Post for v2.0-stable (#1812)
* Release Post for v2.0-stable
* fix(release): resolve v2.0-stable docs build blockers
* chore(release): update v2.0-stable post title
* Update website/releases/v2.0-stable.md
* fix cdc tag
* cdc tag fix
* fix(releases): migrate change data capture tag to cdc
* docs(release): version v2.0-stable as latest
Snapshot docs/ into versioned_docs/version-2.0.x/ via create-release.sh, promoting v2.0 to latest (/docs) and keeping trunk as Next (/docs/next).
Fix off-by-one ../ in non-markdown links across 36 index files (in both version-2.0.x and trunk docs/) that resolve at /docs/next but escape above the docs root when built as the latest version, plus a cross-version anchor leak in v1.7 (scalar_functions#embed). Markdown (.md) links untouched. Verified with a clean npm run build.
---------
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
4 months ago
docs(tracing): the SPICED_LOG equivalents did not match the filter spiced installs (#2211)
* docs(tracing): the SPICED_LOG equivalents did not match the filter spiced installs
The documented per-level SPICED_LOG strings listed nine internal components
and a single off-filter, and gave the trailing global level as DEBUG for -v
and TRACE for -vv. env_filter_string() in bin/spiced/src/tracing.rs composes
internal_components(level) + OFF_FILTERS [+ OFF_UNLESS_VERY_VERBOSE_FILTERS]
+ a global level that is WARN / INFO / DEBUG respectively - it has never been
DEBUG at -v or TRACE at -vv in any release back to v1.5.
Regenerate all three strings per snapshot from the constants at that release's
tag, so each version's page carries its own component list and off-filter set.
* docs(tracing): not every held-down target is off from v2.0
OFF_FILTERS pins opentelemetry to warn from v2.0.0, and
OFF_UNLESS_VERY_VERBOSE_FILTERS adds tantivy=warn (v2.0.0) and
text_embeddings_backend_candle=error (v2.2.0), so 'turned off outright' is
only exact on the 1.x snapshots. Split the wording per version.
* docs(tracing): name the noisy-target overrides the -v and -vv fallbacks do not cover
The -v and -vv sections said the filter raises Spice's components and sets
'everything else' to INFO / DEBUG. The trailing level is the fallback for
targets the filter does not name, but each string also pins a dozen noisy
targets to off/warn/error, so 'everything else' overstated what the fallback
reaches.
Each section now names the fallback and the exception, with the exception's
level set derived from that snapshot's own filter string: 'off' alone for
1.5.x-1.11.x, 'off' or 'warn' for 2.0.x-2.1.x, and 'off', 'warn' or 'error'
for 2.2.x onward. The -vv wording additionally distinguishes the filters that
are lifted at very-verbose from the ones that stay held down.
The Default section carried the same over-claim in the other direction on
2.0.x and 2.1.x, which have no '=error' directive yet advertised 'warn'/'error';
both now say 'warn'.
* docs(tracing): drop 'warn' from the default level's held-down list, where it is the fallback
At the default level the trailing fallback is WARN, so an explicit
'opentelemetry=warn' or 'tantivy=warn' admits exactly what the fallback
already admits. Listing 'warn' among the targets 'held down further still'
claimed a suppression those directives do not perform; only 'off', and
'error' where the snapshot has it, sit below the fallback.
Measured with tracing-subscriber 0.3.23 against the default string: tantivy
and opentelemetry both pass ERROR and WARN, identical to an unnamed target,
while reqwest_retry::middleware is silenced and
text_embeddings_backend_candle passes ERROR alone.
The -v and -vv sections are unaffected: their fallbacks are INFO and DEBUG,
so a 'warn' directive is genuinely more restrictive there.