Commit Graph

6 Commits

Author SHA1 Message Date
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
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
Gwen Shapira 7599d5d78b MINOR: Fix document header/footer links
Based on:  https://github.com/apache/kafka-site/pull/27

I recommend also merging into 10.1.0.0 branch to avoid mishaps when re-publishing docs.

Author: Gwen Shapira <cshapi@gmail.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #2077 from gwenshap/protocol_doc_fix
2016-12-21 13:33:39 -08: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
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
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