KAFKA-15307: Kafka Streams configuration docs outdated

[shashankhs11]

Added new section for window serdes and update Streams configuration
page accordingly.

Reviewers: Matthias J. Sax [email protected]

[shashankhs11]

Tagging @mjsax for review.

Also, I need help in rendering the html to preview my changes. I was able to find the guidelines to render the kafka-site repo but not the Kafka Code repo. Is there a way we can preview these changes?

[mimaison]

You can run ./gradlew siteDocsTar to generate the website archive. Then to preview it, extract it in your kafka-site repository and run ./start-preview.sh

[shashankhs11]

This is the preview of the changes in datatypes.html

This is the first iteration of the changes, I think it does not look very clean, tbh, but I will work on this actively to get it completed asap.

I would really appreciate any inputs on what kind of details to include from a user's perspective for all the new details.

• Should we include code examples?
• Should we include details like in previous sections (setting configs)?

[mjsax]

Made a pass.

@mimaison -- I don't think we should block the next RC on this PR. Might take a little longer. We can always update kafka-site later.

[shashankhs11]

kafka/docs/streams/developer-guide/datatypes.html

Line 107 in ad04ddb

<version>2.8.0</version>

Should we change the above line to

<version>{{fullDotVersion}}</version>

Is it required to be the specific version 2.8.0?

[mjsax]

Yes... Seems this is incorrect for many years... and when we move off hard-coded versions to {{fullDotVersion}} we overlooked it, but nobody noticed until now...

[mjsax]

Overall LGTM. One smaller nit comment. Also great find about the version issues. Let's include this fix.

[shashankhs11]

made the required changes @mjsax

[mjsax]

Will hold of merging until 4.1 went out, and I can cherry-pick to AK 4.1 branch, and you can do a PR against kafka-site.git to get the change live right away.

[shashankhs11]

Sounds good! Thank you!

Also, I would like to suggest a minor addition to this page - Contributing Website Documentation Changes

I would like to add a step to preview changes from kafka code repository which seems to be missing. Like as mentioned here - #20408 (comment)

[shashankhs11]

you can do a PR against kafka-site.git

Here is the PR apache/kafka-site#716 :)

[mimaison]

Will hold of merging until 4.1 went out, and I can cherry-pick to AK 4.1 branch

Feel free to merge and backport to 4.1. I've bumped 4.1 to 4.1.1-SNAPSHOT, it's open to commits