Add Korvet documentation (latest) - #3868
Draft
joshrotenberg wants to merge 4 commits into
Draft
Conversation
Korvet is a Kafka-compatible streaming service backed by Redis Streams, developed by Redis Field Engineering. This adds the product landing page, the reference section index, and the two architecture images, as the skeleton for a 1:1 port of the existing Korvet docs (release 0.19) from redis-field-engineering.github.io/korvet.
|
|
Contributor
Contributor
1:1 format port of the published Korvet docs (release 0.19) from Antora/AsciiDoc to Hugo Markdown: Get Started, Concepts & Architecture, Using the Kafka API, Tiered Storage, Operations, and Reference (configuration, API, metrics, FAQ). Prose is carried over verbatim; only syntax changed (frontmatter, relrefs, admonition shortcodes, fenced code blocks, Markdown tables, inlined metrics partials). Not ported, per the migration plan: the 'Under the Hood' internals section (stays in the korvet repo); links to it are de-linked. The standalone generated configuration page is folded into the Configuration reference page, matching the published nav.
Every section _index.md in an integrate product tree carries type: integration, group, and summary (see the RDI subtree) so nested section pages do not fall through to the integrate card-grid template, which requires a non-nil group on child sections and fails the build otherwise (integrate/list.html: index of $labelColors with nil).
The theme renders the description above the body, and the body's first line is the same sentence; the RDI landing page uses a null description for the same reason.
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
3 participants
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.
What
Adds documentation for Korvet, the Kafka-compatible streaming service backed by Redis Streams from Redis Field Engineering, under
content/integrate/korvet/— modeled on the Redis Data Integration subtree.This is a ~1:1 port of the existing Antora site (https://redis-field-engineering.github.io/korvet/, release 0.19) to Hugo Markdown: format conversion only (frontmatter, relrefs, shortcodes, fenced code blocks); prose is carried over verbatim. Editorial/house-style passes come as follow-ups once this lands.
Scope
static/images/korvet/reference/design/*); the 9 links to it are de-linked (link text kept as plain text)Porting notes
{github-url}resolves to https://github.com/redis-field-engineering/korvet-dist (the public distribution repo), matching the current Antora sitefeatures/schema-registry→kafka-api/schema-registry,admin-api→operations/admin-apireference/configuration.md, exactly as the published Configuration page renders it; the standalone orphan page that Antoraincluded was not carried over. Emitting this reference as Markdown from the Korvet build is a planned follow-updata/doc_bundles.json(the documentation-download widget), like RDI and RedisVL? Its pages are already included in the whole-integratebundlereference/faq.mdlinks tostorage/redis-streams#value-mapper-selection, which no longer exists on the target page in 0.19Plan
_index.md, reference section index, imagesTracked in redis-field-engineering/korvet#1472.