Migrate user-facing docs to the eql_v3#317
Merged
Merged
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…iants and eql_v3.json
…b durable performance guidance; drop operator-class recipe
…-author operators and keep eql_v3 surface
… client-side config round-trip
…inks to client-side config
…ts, permissions, getting started, versioning)
…solete documentation-inventory.md
The doc migration predated the version() port, so version() was documented
nowhere and docker/README still referenced the removed eql_v2 surface.
- README.md: add a 'SELECT eql_v3.version()' check to the Versioning section.
- docker/README.md: repoint the intro prose ('eql_v2 schema') and the version
example onto eql_v3 (the file was missed by the migration).
- docs_v3_grep.sh: add docker/README.md to the Tier-1 gate so it stays
eql_v2-free.
eql_v3.version() ships from the remove-eql-v2 branch.
…urface Replace the removed eql_v2 architecture (eql_v2_encrypted composite, config table, old src/ layout, db-side index config) with the v3 model: per-scalar eql_v3.<T> domains, the catalog/codegen build, functional indexes on extractors, and client-side configuration.
…md links - json-support: fix ste_vec ORE leaf term key ocv/ocf -> oc (matches src/v3/jsonb) - releasing-an-alpha: correct artifact model to the two real release artifacts (cipherstash-encrypt.sql is the self-contained eql_v3 surface) + docs bundle - sql-documentation-templates: drop dead @see add_search_config; AS [base_type] -> AS jsonb (no domain-over-domain footgun) - repoint inbound PAYLOAD.md links (docs index, eql-functions, proxy-configuration) to crates/eql-types (canonical wire types) + json-support.md - WHY: markdown spacing fix
tobyhede
force-pushed
the
migrate-docs-to-eql-v3
branch
from
9147054 to
7ecd15d
Compare
tobyhede
changed the title
…ng docs Correct the remaining "eql_v2 coexists / is the unchanged public API" framing to match reality: eql_v2 was removed in 3.0.0 and eql_v3 is the sole shipped surface. - DEVELOPMENT.md: replace the coexistence "Schemas" section with an accurate "The eql_v3 surface" section (v2 removed, fork-provenance/historical mentions flagged as deliberate); fix TOC anchor. - CLAUDE.md: fix the Schema bullet and Versioning paragraph that still asserted eql_v2 coexists/unchanged. - SUPABASE.md: reword the two remaining v2 callouts to teach the v3 way with no v2 references (a separate v2->v3 migration guide can come later). - docs/development/reference-sync-rules.md: update stale eql_v2 examples to verified v3 symbols (eql_v3.ciphertext, eql_v3.eq_term). Remove obsolete/invented artifacts and dead v2 fixtures: - delete docs/decisions/0001-remove-eql-v2.md and docs/plans/add-doxygen-sql-comments-plan.md; strip the 3 dangling ADR links from CHANGELOG (entries already explain the why inline). - delete tests/ORE_FIXTURES.md (documented the removed v2 proxy fixture flow; v3 ORE coverage is subsumed by catalog-generated scalar fixtures) and the orphaned tests/ore.sql / tests/ore_text.sql data files (loaded by nothing). Guard: refactor tasks/test/docs_v3_grep.sh from a hand-maintained allowlist to scan-all-with-exclusions over git-tracked docs (new reference/tutorial/concept pages covered automatically; untracked scratch ignored), and wire it into the docs-static CI job (runs on every PR, already in ci-required).
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
1 participant
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.
Re-authors the user-facing documentation onto the self-contained
eql_v3surface, following theeql_v2removal (#315, which this stacks on). Deferred from #315 to keep that PR scoped to the SQL/build changes.What changed
eql_v3; the Versioning section now showsSELECT eql_v3.version().docs/reference/eql-functions.md— dropped the removedeql_v2config/extractor/helper sections; re-authored operators around theeql_v3surface (−756 lines).docs/reference/database-indexes.md— re-authored ontoeql_v3functional indexes; absorbed durable performance guidance; dropped the operator-class recipe.docs/reference/sql-support.md— capability matrix re-authored ontoeql_v3domain variants andeql_v3.json.docs/reference/json-support.md— re-authored onto theeql_v3.jsonSteVec document type.docs/reference/query-performance.md— reduced to a pointer intodatabase-indexes.md.docs/reference/index-config.md— removed (db-side config is gone); links repointed to client-side config.docs/tutorials/proxy-configuration.md— re-authored ontoeql_v3columns and the client-side config round-trip.docs/development/*— light cleanup of v3 reference/dev examples; deleted the obsoletedocumentation-inventory.md.docker/README.md— repointed the intro prose and the version example ontoeql_v3.Guardrail
Adds
tasks/test/docs_v3_grep.sh— a CI gate that fails if any Tier-1 user-facing doc still referenceseql_v2. The ADR and the historicalv2.3upgrade guide are deliberately exempt (theireql_v2references are correct).Notes
remove-eql-v2; theeql_v3.version()function it documents ships from that branch (Remove eql_v2 — ship only the self-contained eql_v3 surface #315).docs/upgrading/v2.3.mdanddocs/decisions/0001-remove-eql-v2.mdintentionally retaineql_v2references.