[fix](doc) clean up table-design, vector index, lakehouse, and view docs#3718
Open
boluor wants to merge 1 commit into
Open
[fix](doc) clean up table-design, vector index, lakehouse, and view docs#3718boluor wants to merge 1 commit into
boluor wants to merge 1 commit into
Conversation
- SHOW-VIEW.md: replace informal `grammar:` line with `## Syntax` heading and remove empty `## Best Practice` section. - data-type.md DECIMAL row: close `<ul>` properly (was a second `<ul>`), close each `<li>`, and fix `16 < precision <= 38` to `18 < precision <= 38`. - prefix-index.md: dedupe `Prefix Index` and `Sort Key` in frontmatter keywords. - ngram-bloomfilter-index.md: rewrite SELECT to use `any_value(product_title)` so it matches the result-table headers shown below. - custom-analyzer.md: remove stray `</content></invoke>` trailer left from a previous edit, dedupe `custom analyzer` keyword, and rename `min_ngram`/`max_ngram` in the parameter table and descriptions to `min_gram`/`max_gram` to match the working examples and the Lucene tokenizer parameters Doris uses. - hnsw.md: memory-footprint sentence said "1.2x" while the formula and the example calculation use 1.3x — change the sentence to 1.3x. - ivf.md: reference table cell for 128-dim / 1M was 496 MB, mismatching the "≈ 500 MB" formula immediately above — align to 500 MB. - vector-index/overview.md: the Prepared Statement example used `FROM l2_distance_approximate` (a scalar function, not a table) instead of `FROM sift_1M` like the surrounding examples. - bigquery.md: fix malformed Google Cloud docs URL `cloud.google.com/bigquerydocs/exporting-data` → `cloud.google.com/bigquery/docs/exporting-data`. - jdbc-catalog-overview.md: upgrade Maven Central example URL from `http://repo1.maven.org` to `https://`. Applied consistently across `docs/`, the matching `versioned_docs/version-{2.1,3.x,4.x}/` trees, and the corresponding `i18n/zh-CN/` files where the same content exists. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A pass of small correctness fixes across
docs/,versioned_docs/version-{2.1,3.x,4.x}/, and the matchingi18n/zh-CN/files.sql-manual/.../view/SHOW-VIEW.mdgrammar:label with a proper## Syntaxheading.## Best Practicesection.table-design/data-type.md— DECIMAL rowThe cell mixed two bugs:
<ul>with another opening<ul>instead of</ul>, so the list never closed in HTML.When 16 < precision <= 38(overlapping with the previous bullet). It should beWhen 18 < precision <= 38, matching the boundaries used in theversion-3.x/version-2.1docs.Also close each
<li>explicitly to match the corrected</ul>.table-design/index/prefix-index.mdFrontmatter
keywordslistedPrefix IndexandSort Keytwice each — dedupe.table-design/index/ngram-bloomfilter-index.mdThe example
SELECTprojectsany(product_title), but the result-table headers shown immediately below areany_value(product_title). Rewrite the SELECT toany_value(product_title)so the displayed result actually matches the query a reader would copy.table-design/index/inverted-index/custom-analyzer.md</content></invoke>block at the bottom of the file (looks like residue from a previous edit) —version-4.xandcurrentwere affected.custom analyzerin the frontmatterkeywords.min_ngram/max_ngramtomin_gram/max_gramin the parameter table and the bulleted parameter descriptions. Every working example in the same file, and the underlying tokenizer parameters Doris uses, aremin_gram/max_gram.table-design/index/vector-index/hnsw.mdThe prose said "…takes about 1.2x the memory…" while the formula on the very next line, and the example calculation that arrives at 650 MB, both use 1.3x. Update the prose to 1.3x.
table-design/index/vector-index/ivf.mdFor 128-dim / 1M rows, the formula above the table evaluates to "≈ 500 MB" while the reference-values table directly below says 496 MB. Align the table cell to 500 MB so the two presentations agree.
table-design/index/vector-index/overview.mdThe Prepared Statement example used
FROM l2_distance_approximate— that's the scalar function being projected, not a table. The intended table (used by all surrounding examples in this file) issift_1M.data-operate/import/data-source/bigquery.mdhttps://cloud.google.com/bigquerydocs/exporting-datais a 404. The correct path ishttps://cloud.google.com/bigquery/docs/exporting-data.lakehouse/catalogs/jdbc-catalog-overview.mdThe Maven Central example URL was given over plain HTTP (
http://repo1.maven.org/...).repo1.maven.orgredirects/enforces HTTPS, so the example fails as-shown — change tohttps://.Test plan
docs/,versioned_docs/, andi18n/zh-CN/where the same content exists.