Commit Graph

21 Commits

Author SHA1 Message Date
Tom Bentley 9e35a2aa78 MINOR: Add <p>/</p> to connect docs, because HTML render doesn't respect blank lines
This just adds `<p>`/`</p>` to paragraphs in Kafak Connect docs.

ewencp are you a good person to review this?

Author: Tom Bentley <tbentley@redhat.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #4008 from tombentley/MINOR-connect-docs-paragraph
2017-10-03 10:25:09 -07:00
Robin Moffatt f4d1305bfe MINOR: Fix typo in SMT doc: s/RegexpRouter/RegexRouter
Author: Robin Moffatt <robin@rmoff.net>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #3576 from rmoff/patch-1
2017-07-26 09:17:44 -07:00
ppatierno 8a81566214 KAFKA-5410; Fix taskClass() method name in Connector and flush() signature in SinkTask
Author: ppatierno <ppatierno@live.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #3269 from ppatierno/connect-doc
2017-07-20 19:51:09 -07:00
Guozhang Wang 57b0d0fe57 MINOR: syntax brush for java / bash / json / text
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Derrick Or <derrickor@gmail.com>, Ismael Juma <ismael@juma.me.uk>

Closes #3214 from guozhangwang/KMinor-doc-java-brush
2017-06-07 15:17:25 +01:00
Gwen Shapira 95ef40dd31 MINOR: Adding example to SMT documentation
Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #2721 from gwenshap/improve_smt_docs
2017-03-22 23:06:26 -07:00
Sönke Liebau b1272500bd KAFKA-4567 - Connect Producer and Consumer ignore ssl parameters…
KAFKA-4567 - Connect Producer and Consumer ignore ssl parameters configured for worker

Added brief explanation to the docs about parameter inheritance of Kafka consumers and producers from the worker config.

Author: Sönke Liebau <soenke.liebau@opencore.com>

Reviewers: Gwen Shapira

Closes #2511 from soenkeliebau/KAFKA-4567
2017-03-05 10:28:36 -08:00
Shikhar Bhushan a8aa756166 KAFKA-3209: KIP-66: more single message transforms
Renames `HoistToStruct` SMT to `HoistField`.

Adds the following SMTs:
`ExtractField`
`MaskField`
`RegexRouter`
`ReplaceField`
`SetSchemaMetadata`
`ValueToKey`

Adds HTML doc generation and updates to `connect.html`.

Author: Shikhar Bhushan <shikhar@confluent.io>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #2374 from shikhar/more-smt
2017-01-20 16:15:15 -08:00
Derrick Or 53428694a6 Separate Streams documentation and setup docs with easy to set variables
- Seperate Streams documentation out to a standalone page.
- Setup templates to use handlebars.js
- Create template variables to swap in frequently updated values like version number from a single file templateData.js

Author: Derrick Or <derrickor@gmail.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #2245 from derrickdoo/docTemplates
2016-12-13 17:59:49 -08:00
Vahid Hashemian e972d2afd3 MINOR: Fix typos in documentation
And improve readability by adding proper punctuations.

Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #2002 from vahidhashemian/doc/fix_typos
2016-10-10 15:58:37 -07:00
Mathieu Fenniak ca3f3a492c MINOR: Document that Connect topics should use compaction
Update documentation for Kafka Connect distributed’s config.storage.topic, offset.storage.topic, and status.storage.topic configuration values to indicate that all three should refer to compacted topics.

Author: Mathieu Fenniak <mathieu.fenniak@replicon.com>

Reviewers: Jason Gustafson

Closes #1832 from mfenniak/kafka-connect-topic-docs
2016-09-07 17:34:24 -07:00
Ewen Cheslack-Postava 05ed54bf2b KAFKA-3845: KIP-75: Add per-connector converters
Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Shikhar Bhushan, Gwen Shapira

Closes #1721 from ewencp/kafka-3845-per-connector-converters
2016-08-18 20:56:31 -07:00
uchan-nos 250981fb98 MINOR: Fix connect development guide.
Fix some trivial misses.
ewencp

Author: uchan-nos <uchan0@gmail.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1496 from uchan-nos/docfix-connect
2016-06-11 17:20:23 -07:00
Liquan Pei 527b98d82f KAFKA-3421: Connect developer guide update and several fixes
This is a follow up of KAKFA-3421 to update the connect developer guide to include the configuration validation. Also includes a couple of minor fixes.

Author: Liquan Pei <liquanpei@gmail.com>

Reviewers: Jason Gustafson <jason@confluent.io>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1366 from Ishiihara/connect-dev-doc
2016-05-12 18:15:04 -07:00
Jason Gustafson 4807dd1df9 KAFKA-3583: Add documentation for Connect status control APIs
Author: Jason Gustafson <jason@confluent.io>

Reviewers: Roger Hoover <roger.hoover@gmail.com>, Ismael Juma <ismael@juma.me.uk>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1358 from hachikuji/KAFKA-3583
2016-05-11 17:19:11 -07:00
Ewen Cheslack-Postava 36ed00d9bf KAFKA-3421; Follow up to fix name of SourceTask method and add documentation of connector status REST API
Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #1355 from ewencp/kafka-3421-follow-up
2016-05-09 23:42:09 +01:00
Kaufman Ng b86378840a KAFKA-3681; Connect doc formatting
Author: Kaufman Ng <kaufman@confluent.io>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #1351 from coughman/KAFKA-3681-connect-doc-formatting
2016-05-09 17:01:16 +01:00
Liquan Pei 501fa37222 KAFKA-3421: Update docs with new connector features
ewencp gwenshap Docs. I also tried to clean up some typos. However, it seems that the we don't have two words without space in between in the source yet they showed up as no space in between in the generated doc.

Author: Liquan Pei <liquanpei@gmail.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #1227 from Ishiihara/config-doc
2016-04-19 11:06:31 -07:00
Dongjoon Hyun e79d9af3cf KAFKA-3461: Fix typos in Kafka web documentations.
This PR fixes 8 typos in HTML files of `docs` module. I wrote explicitly here since Github sometimes does not highlight the corrections on long lines correctly.
- docs/api.html: compatability => compatibility
- docs/connect.html: simultaneoulsy => simultaneously
- docs/implementation.html: LATIEST_TIME => LATEST_TIME, nPartions => nPartitions
- docs/migration.html: Decomission => Decommission
- docs/ops.html: stoping => stopping, ConumserGroupCommand => ConsumerGroupCommand, youre => you're

Author: Dongjoon Hyun <dongjoon@apache.org>

Reviewers: Ismael Juma

Closes #1138 from dongjoon-hyun/KAFKA-3461
2016-04-12 13:48:18 -07:00
Sasaki Toru 291f430d9c MINOR: Fix typos in docs
Author: Sasaki Toru <sasakitoa@nttdata.co.jp>

Reviewers: Gwen Shapira

Closes #1003 from sasakitoa/Fix_typo_in_docs
2016-03-03 11:46:16 -08:00
Grant Henke 6cbd97597c KAFKA-2809; Improve documentation linking
Often it is useful to link to a specific header within the documentation. Especially when referencing docs in the mailing lists.

This adds anchors and links for all headers in the docs.

Author: Grant Henke <granthenke@gmail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #498 from granthenke/doc-links
2015-11-16 14:14:17 -08:00
Ewen Cheslack-Postava 83eaf3284f KAFKA-2379: Add basic documentation for Kafka Connect.
Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Gwen Shapira

Closes #475 from ewencp/kafka-2379-connect-docs
2015-11-09 16:29:30 -08:00