Commit Graph

27 Commits

Author SHA1 Message Date
Ken Huang b129ed4566
MINOR: Use immutable KIP link (#19153)
Reviewers: TengYao Chi <kitingiao@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2025-03-09 23:42:33 +08:00
Jongho Jeon 48475e89ca
MINOR: Fix broken link in introduction.html (#11249)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2021-10-11 16:45:36 +02:00
Bill Bejeck b4f00d7ef6
KAFKA-10679: Migrate upgrade changes from site to kafka/docs (#9551)
During the AK website upgrade, changes made to kafka-site weren't migrated back to kafka-docs.

This PR is an initial attempt at porting the changes to kafka/docs, but it does not include the streams changes. Those will come in a separate PR.

For the most part, the bulk of the changes in the PR are cosmetic. Only the introduction.html has substantial changes, but it's a direct port from the live documentation.

For testing:

I reviewed the PR diffs
Rendered the changes locally

Reviewers: Matthias J. Sax <mjsax@apache.org>
2020-11-03 13:40:44 -05:00
Gal Margalit 5dade71a8f
MINOR: Update introduction.html (#8969) 2020-07-02 05:21:29 +05:30
commandini 9d96964792 MINOR: Update introduction page in Kafka documentation
Although APIs section in Kafka documentation lists 5 core APIs (https://kafka.apache.org/documentation/#api), introduction page in Kafka documentation lists 4 of them. I've added the missing list element to fix this incoherence.

Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>
2020-01-20 22:19:41 +05:30
Harsha Laxman 6e56ba4b7d Update introduction.html (#7853)
Fixing small grammar issue with plural versions

Reviewers: Mickael Maison <mickael.maison@gmail.com>
2019-12-19 13:04:38 +00:00
Joel Hamill 48f5f048bc MINOR: kafka-site introduction section improvements
*Clarify multi-tenant support, geo-replication, and some grammar fixes.*

Author: Joel Hamill <joel-hamill@users.noreply.github.com>

Reviewers: GUozhang Wang

Closes #4212 from joel-hamill/intro-cleanup
2017-11-15 14:32:00 -08:00
Derrick Or f29203d022 Update docs to reflect kafka trademark status
Updated a couple places in docs with the 'registered' trademark symbol.

Author: Derrick Or <derrickor@gmail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #4028 from derrickdoo/kafka-trademark-status
2017-10-05 13:31:18 -07:00
Joel Hamill d985513b22 MINOR: streams dev guide fixup
Author: Joel Hamill <joel@Joel-Hamill-Confluent.local>
Author: Joel Hamill <11722533+joel-hamill@users.noreply.github.com>

Reviewers: Derrick Or <derrickor@gmail.com>, Michael G. Noll <michael@confluent.io>, Guozhang Wang <wangguoz@gmail.com>

Closes #3862 from joel-hamill/joel-hamill/streams-dev-guide
2017-10-04 11:28:59 -07:00
Guozhang Wang 5704d8f05f HOTFIX: add the hyper link for storage
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Damian Guy <damian.guy@gmail.com>

Closes #3617 from guozhangwang/KHotfix-introduction-hyperlink
2017-08-04 09:16:57 -07:00
Matthias J. Sax 2c91b324d4 HOTFIX: fixed section incompatible Steams API changes
Author: Matthias J. Sax <matthias@confluent.io>

Reviewers: Damian Guy, Guozhang Wang

Closes #2492 from mjsax/hotfixDocs
2017-02-15 13:17:29 -08:00
Guozhang Wang a15fcea799 MINOR: add architecture section and configure / execution for streams
1. Added an architecture section.
2. Added a configuration / execution sub-section to developer guide.

Minor tweaks and a bunch of missing fixes from `kafka-site` repo.

Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Matthias J. Sax <matthias@confluent.io>, Derrick Or <derrickor@gmail.com>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #2488 from guozhangwang/KMinor-streams-docs-second-pass
2017-02-09 19:13:23 -08:00
Hikiko Murakami e55205b810 MINOR: Fix typo on introduction page
Author: ash <ashishg@qburst.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #2259 from ashishg-qburst/intro
2016-12-15 17:26:44 -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
Jason Gustafson 9662e466d9 MINOR: Some images should be centered in the documentation
Author: Jason Gustafson <jason@confluent.io>

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

Closes #2029 from hachikuji/center-some-images
2016-10-14 10:04:13 -07: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
Gwen Shapira bf98c47389 KAFKA-4244; Fix formatting issues in documentation
Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #1966 from gwenshap/KAFKA-4244
2016-10-10 13:39:05 -07:00
Jakub Dziworski 7a5133d554 MINOR: Fixed introduction doc - wrong streams api link
Author: Jakub Dziworski <jakub.dziworski@gmail.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>, Jason Gustafson <jason@confluent.io>

Closes #1996 from JakubDziworski/doc_fix_streams_link
2016-10-10 10:15:47 -07:00
Jakub Dziworski fb22685fa9 MINOR: Fixed incomplete sentence in introduction docs
Author: Jakub Dziworski <jakub.dziworski@gmail.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>, Jason Gustafson <jason@confluent.io>

Closes #1994 from JakubDziworski/doc_fix
2016-10-10 09:26:37 -07:00
Jay Kreps 16f85e84ce MINOR: Improve introduction section in docs to better cover connect and streams. Make uses and ecosystem pages stand alone. 2016-09-28 16:30:21 -07:00
sahil kharb 8abcece40a MINOR: Doc individual partition must fit on the server that host it
Author: sahil kharb <sahilkharb@iitj.ac.in>

Reviewers: Ismael Juma, Guozhang Wang

Closes #1709 from bitfurry/trunk
2016-08-09 11:27:57 -07:00
Ashish Singh eb1de107b0 MINOR: Update protocol doc link in Introduction.
Author: Ashish Singh <asingh@cloudera.com>

Reviewers: Gwen Shapira

Closes #1211 from SinghAsDev/MinorFixDocLink
2016-05-09 16:47:20 -07:00
Vahid Hashemian d00cf520fb MINOR: Improve Kafka documentation
Improve the documentation by fixing typos, punctuations, and correcting the content.

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

Reviewers: Grant Henke <granthenke@gmail.com>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #778 from vahidhashemian/typo05/fix_documentation_typos
2016-01-23 22:26:53 -08:00
Alex Loddengaard f7fc285386 MINOR: Trivial doc/ typo fixes.
The change in `docs/design.html` is hard to catch in the diff -- a `tbe` is changed to `the`. All other changes show up clearly in the diff.

This contribution is my original work and I license the work to the project under the project's open source license.

Author: Alex Loddengaard <alexloddengaard@gmail.com>

Reviewers: Grant Henke, Gwen Shapira

Closes #654 from alexlod/doc-typo-fixes
2015-12-09 17:39:53 -06: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
Gwen Shapira 78a2e2f8f3 KAFKA-2665: Add images to code github
…art of the code github

Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Guozhang Wang

Closes #325 from gwenshap/KAFKA-2665
2015-10-16 17:52:06 -07:00
Manikumar reddy O 4016011457 KAFKA-2425; Copy latest docs to kafka repo docs/ directory
This PR copies the latest kafka docs to kafka repo docs directory. Here I have copied 0.8.3/ directory contents from svn website repo to kafka/docs repository.

Some questions: This PR contains generated javadocs also.  Do we need to copy javadocs here?

Author: Manikumar reddy O <manikumar.reddy@gmail.com>

Reviewers: Gwen Shapira, Ismael Juma

Closes #171 from omkreddy/KAFKA-2425-MOVE-DOCS-TO-KAFKA-REPO
2015-10-03 06:50:45 -07:00