Skip to content

KAFKA-20366: Add syntax highlighting in security docs#21965

Merged
mimaison merged 6 commits intoapache:trunkfrom
gomudayya:KAFKA-20366-part2
Apr 29, 2026
Merged

KAFKA-20366: Add syntax highlighting in security docs#21965
mimaison merged 6 commits intoapache:trunkfrom
gomudayya:KAFKA-20366-part2

Conversation

@gomudayya
Copy link
Copy Markdown
Contributor

@gomudayya gomudayya commented Apr 4, 2026

@github-actions github-actions Bot added triage PRs from the community docs labels Apr 4, 2026
Copy link
Copy Markdown
Member

@mimaison mimaison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. I left a couple of comments

1. Add a JAAS config file with a client login section named `KafkaClient`. Configure a login module in `KafkaClient` for the selected mechanism as described in the examples for setting up GSSAPI (Kerberos), PLAIN, SCRAM, or non-production/production OAUTHBEARER. For example, GSSAPI credentials may be configured as:

```
```text
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any value in setting the language to test?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's to enable the copy icon, and to keep it consistently handled by Hugo's code block render hook.

user_admin="admin-secret" \
user_alice="alice-secret";

```properties
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is properties the correct language? According to https://gohugo.io/content-management/syntax-highlighting/#languages I see it called java-properties

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I built the Kafka website locally, it rendered with highlighting, so I didn't notice the issue.
As you pointed out, java-properties is the officially documented identifier in Hugo, so I'll update it accordingly.

@mimaison
Copy link
Copy Markdown
Member

I'd recommend doing it one folder at a time. It does not make a lot of sense to do Streams and Security in the same PR.

@github-actions github-actions Bot removed the triage PRs from the community label Apr 11, 2026
@gomudayya
Copy link
Copy Markdown
Contributor Author

gomudayya commented Apr 19, 2026

I'd recommend doing it one folder at a time. It does not make a lot of sense to do Streams and Security in the same PR.

Agreed. I'll revert the Streams changes from this PR and update the title and description accordingly. I'll open a separate PR for Streams afterward. Thanks for the review!

Copy link
Copy Markdown
Member

@mimaison mimaison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mimaison mimaison changed the title KAFKA-20366: Add syntax highlighting across docs (security and streams) KAFKA-20366: Add syntax highlighting in security docs Apr 29, 2026
@mimaison mimaison merged commit 8a1c198 into apache:trunk Apr 29, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants