Skip to content

Commit 57d9fb6

Browse files
committed
fix issues with overview and blog
Signed-off-by: Grace Grimwood <[email protected]>
1 parent 94d162d commit 57d9fb6

File tree

7 files changed

+38
-37
lines changed

7 files changed

+38
-37
lines changed

_includes/footer.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
</ul>
3737
</div>
3838
<div class="col-6 col-lg-2 offset-lg-2 mb-3 text-lg-end">
39-
<h3 class="fs-5">Links</h3>
39+
<h1 class="fs-5">Links</h1>
4040
<ul class="list-unstyled">
4141
<li class="mb-2">
4242
<a class="text-body link-underline-dark link-underline-opacity-0 link-underline-opacity-10-hover" href="{{ '/' | absolute_url }}">
@@ -61,7 +61,7 @@ <h3 class="fs-5">Links</h3>
6161
</ul>
6262
</div>
6363
<div class="col-6 col-lg-2 mb-3 text-lg-end">
64-
<h3 class="fs-5">Projects</h3>
64+
<h1 class="fs-5">Projects</h1>
6565
<ul class="list-unstyled">
6666
<li class="mb-2">
6767
<a class="text-body link-underline-dark link-underline-opacity-0 link-underline-opacity-10-hover" href="https://github.com/kroxylicious/kroxylicious">
@@ -76,7 +76,7 @@ <h3 class="fs-5">Projects</h3>
7676
</ul>
7777
</div>
7878
<div class="col-6 col-lg-2 mb-3 text-lg-end">
79-
<h3 class="fs-5">Community</h3>
79+
<h1 class="fs-5">Community</h1>
8080
<ul class="list-unstyled">
8181
<li class="mb-2">
8282
<a class="text-body link-underline-dark link-underline-opacity-0 link-underline-opacity-10-hover" href="https://kroxylicious.slack.com" target="_blank" rel="noopener">

_includes/nested-card-tabbed/tab.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
<li class="nav-item">
1+
<li class="nav-item" role="tab">
22
<button class="nav-link krx-card-nav-link {% if include.is_active_tab %}active{% endif %}"
33
id="{{ include.htmlid }}" data-bs-toggle="tab"
44
data-bs-target="#{{ include.htmlid }}-tab-pane" type="button"
5-
role="tab" aria-controls="{{ include.htmlid }}-tab-pane"
5+
aria-controls="{{ include.htmlid }}-tab-pane"
66
{% if include.is_active_tab %}aria-current="true"{% endif %}
77
aria-selected="{{ include.is_active_tab }}">
88
{{ include.tab_title | markdownify }}

_layouts/blog.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<div class="col-lg-3 mb-5">
66
<div class="card px-2 mx-2">
77
<div class="card-body">
8-
<h3 class="card-title">{{ page.title }}</h3>
8+
<h1 class="fs-3" class="card-title">{{ page.title }}</h1>
99
<div class="container g-0 mt-4">
1010
<p class="card-text">
1111
{{ content }}
@@ -35,13 +35,13 @@ <h3 class="card-title">{{ page.title }}</h3>
3535
<div class="col-md align-self-center">
3636
{% endif %}
3737
<div class="card-body mx-3 my-2">
38-
<h4 class="card-title">
38+
<h2 class="card-title fs-4">
3939
<a class="page-link" href="{{ post.url | absolute_url }}">
4040
{{ post.title | escape }}
4141
</a>
42-
</h4>
42+
</h2>
4343
<p class="card-text">{{ post.excerpt | markdownify }}</p>
44-
<p class="card-text text-end"><small class="text-primary">{{ post.date | date: date_format }}</small></p>
44+
<p class="card-text text-end"><small class="text-secondary">{{ post.date | date: date_format }}</small></p>
4545
</div>
4646
</div>
4747
</div>

_quickstarts/deploy.markdown

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ To help you get started with Kroxylicious, we've created this quick setup guide.
77

88
<br />
99

10-
# Getting started
10+
<h1 id="getting-started-deployment">Getting started</h1>
1111

12-
### Prerequisites
12+
<h2 class="fs-3" id="prerequisites-deployment">Prerequisites</h2>
1313

14-
#### Java
14+
<h3 class="fs-4" id="java-deployment">Java</h3>
1515

1616
To get started deploying Kroxylicious, you will need to install a Java Runtime Environment (JRE) with minimum version 17. This does not come included with Kroxylicious.
1717

@@ -27,15 +27,15 @@ If you get an error or the command doesn't return anything, you may not have a J
2727

2828
{% include bs-alert.html type="primary" icon="info-circle-fill" content=jre_note %}
2929

30-
#### Apache Kafka&#174;
30+
<h3 class="fs-4" id="apache-kafka-deployment">Apache Kafka&#174;</h3>
3131

3232
You will also need a running Apache Kafka&#174; cluster for Kroxylicious to proxy. The official Apache Kafka&#174; [quickstart](https://kafka.apache.org/documentation/#quickstart) has instructions for setting up a local bare metal cluster.
3333

34-
Once your cluster is set up, the cluster bootstrap address used by Kroxylicious can be changed in the configuration YAML file (see the [**Configure**](#configure) section below).
34+
Once your cluster is set up, the cluster bootstrap address used by Kroxylicious can be changed in the configuration YAML file (see the [**Configure**](#configure-deployment) section below).
3535

3636
<br />
3737

38-
### Downloading Kroxylicious
38+
<h2 class="fs-3" id="downloading-kroxylicious-deployment">Downloading Kroxylicious</h2>
3939

4040
Kroxylicious can be downloaded from the [releases](https://github.com/kroxylicious/kroxylicious/releases) page of the Kroxylicious GitHub repository, or from Maven Central.
4141

@@ -49,14 +49,14 @@ If you're trying Kroxylicious out on Linux or macOS, you may find the `.tar.gz`
4949

5050
<br />
5151

52-
# Install
52+
<h1 id="install-deployment">Install</h1>
5353

5454
Extract the downloaded Kroxylicious Zip file into the directory you would like to install Kroxylicious in.
5555
Ensure the `kroxylicious-start.sh` and `run-java.sh` files in the `bin/` directory within the extracted folder have at least read and execute (`r-x`) permissions for the owner.
5656

5757
<br />
5858

59-
# Configure
59+
<h1 id="configure-deployment">Configure</h1>
6060

6161
Kroxylicious is configured with YAML. From the configuration file you can specify how Kroxylicious presents each Apache Kafka&#174; broker to clients, where Kroxylicious will locate the Apache Kafka&#174; cluster(s) to be proxied, and which filters Kroxylicious should use along with any configuration for those filters.
6262

@@ -68,7 +68,7 @@ If your machine uses a non-standard port configuration, or if you have used cust
6868

6969
<br />
7070

71-
# Run
71+
<h1 id="run-deployment">Run</h1>
7272

7373
From within the extracted Kroxylicious folder, run the following command:
7474

@@ -80,7 +80,7 @@ To use your own configuration file instead of the example, just replace the file
8080

8181
<br />
8282

83-
# Use
83+
<h1 id="use-deployment">Use</h1>
8484

8585
To use your Kroxylicious proxy, your client(s) will need to point to the proxy (using the configured address) rather than directly at the Apache Kafka&#174; cluster.
8686

@@ -97,23 +97,23 @@ In each command below, substitute `$KROXYLICIOUS_BOOTSTRAP` for the bootstrap ad
9797

9898
<br />
9999

100-
##### 1. Create a topic via Kroxylicious
100+
<h2 class="fs-5">1. Create a topic via Kroxylicious</h2>
101101
Create a topic called "my_topic" using the `kafka-topics.sh` command line client:
102102
```shell
103103
bin/kafka-topics.sh --create --topic my_topic --bootstrap-server $KROXYLICIOUS_BOOTSTRAP
104104
```
105105

106106
<br />
107107

108-
##### 2. Produce a string to your topic via Kroxylicious
108+
<h2 class="fs-5">2. Produce a string to your topic via Kroxylicious</h2>
109109
Produce the string "hello world" to your new topic using the `kafka-console-producer.sh` command line client:
110110
```shell
111111
echo "hello world" | bin/kafka-console-producer.sh --topic my_topic --bootstrap-server $KROXYLICIOUS_BOOTSTRAP
112112
```
113113

114114
<br />
115115

116-
##### 3. Consume your string from your topic via Kroxylicious
116+
<h2 class="fs-5">3. Consume your string from your topic via Kroxylicious</h2>
117117
Consume your string ("hello world") from your topic ("my_topic") using the `kafka-console-consumer.sh` command line client:
118118
```shell
119119
bin/kafka-console-consumer.sh --topic my_topic --from-beginning --bootstrap-server $KROXYLICIOUS_BOOTSTRAP
@@ -125,23 +125,23 @@ In each command below, substitute `$KROXYLICIOUS_BOOTSTRAP` for the bootstrap ad
125125

126126
<br />
127127

128-
##### 1. Create a topic via Kroxylicious
128+
<h2 class="fs-5">1. Create a topic with Kaf via Kroxylicious</h2>
129129
Create a topic called "my_topic" using Kaf:
130130
```shell
131131
kaf -b $KROXYLICIOUS_BOOTSTRAP topic create my_topic
132132
```
133133

134134
<br />
135135

136-
##### 2. Produce a string to your topic via Kroxylicious
136+
<h2 class="fs-5">2. Produce a string to your topic with Kaf via Kroxylicious</h2>
137137
Produce the string "hello world" to your new topic:
138138
```shell
139139
echo "hello world" | kaf -b $KROXYLICIOUS_BOOTSTRAP produce my_topic
140140
```
141141

142142
<br />
143143

144-
##### 3. Consume your string from your topic via Kroxylicious
144+
<h2 class="fs-5">3. Consume your string from your topic with Kaf via Kroxylicious</h2>
145145
Consume your string ("hello world") from your topic ("my_topic"):
146146
```shell
147147
kaf -b $KROXYLICIOUS_BOOTSTRAP consume my_topic

_quickstarts/develop.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ In this quickstart you will build a custom filter and use it to modify messages
88

99
<br />
1010

11-
# Getting started
11+
<h1 id="getting-started-development">Getting started</h1>
1212

13-
### Prerequisites
13+
<h2 class="fs-3" id="prerequisites-development">Prerequisites</h2>
1414

1515
To start developing your own custom filters for Kroxylicious, you will need to install [JDK 21](https://openjdk.org/projects/jdk/21/).
1616

1717
You'll also need to install the [Apache Maven CLI](https://maven.apache.org/index.html) and one of either [Podman](https://podman.io/docs/installation) or [Docker](https://docs.docker.com/install/) (Note that if you are using Podman, you may encounter issues with the integration tests. There are instructions [here](https://github.com/kroxylicious/kroxylicious/blob/main/DEV_GUIDE.md#running-integration-tests-on-podman) to resolve this).
1818

1919
<br />
2020

21-
### Get the code
21+
<h2 class="fs-3" id="get-the-code-development">Get the code</h2>
2222

2323
The easiest way to learn how to build custom filters is with our `kroxylicious-sample` module, which contains some basic find-and-replace filters for you to experiment with.
2424
Begin by downloading the latest `kroxylicious-sample` sources from the [Kroxylicious repository](https://github.com/kroxylicious/kroxylicious).
@@ -29,7 +29,7 @@ git clone https://github.com/kroxylicious/kroxylicious.git
2929

3030
<br />
3131

32-
# Build
32+
<h1 id="build-development">Build</h1>
3333

3434
Building the sample project is easy! You can build the `kroxylicious-sample` jar either on its own or with the rest of the Kroxylicious project.
3535

@@ -47,7 +47,7 @@ mvn verify -Pdist -Dquick
4747

4848
<br />
4949

50-
# Run
50+
<h1 id="run-development">Run</h1>
5151

5252
Build both `kroxylicious-sample` and `kroxylicious-app` with the `dist` profile as above, then run the following command:
5353

@@ -57,7 +57,7 @@ KROXYLICIOUS_CLASSPATH="kroxylicious-sample/target/*" kroxylicious-app/target/kr
5757

5858
<br />
5959

60-
# Configure
60+
<h1 id="configure-development">Configure</h1>
6161

6262
Filters can be added and removed by altering the `filters` list in the `sample-proxy-config.yml` file. You can also reconfigure the sample filters by changing the configuration values in this file.
6363

@@ -68,7 +68,7 @@ The **SampleFetchResponseFilter** and **SampleProduceRequestFilter** each have t
6868

6969
<br />
7070

71-
### Default Configuration
71+
<h2 class="fs-3" id="default-Configuration-development">Default Configuration</h2>
7272

7373
The default configuration for **SampleProduceRequestFilter** is:
7474

@@ -96,6 +96,6 @@ This means that it will search for the string `bar` in the fetch data and replac
9696

9797
<br />
9898

99-
# Modify
99+
<h1 id="modify-development">Modify</h1>
100100

101101
Now that you know how the sample filters work, you can start modifying them! Replace the `SampleFilterTransformer` logic with your own code, change which messages they apply to, or whatever else you like!

_sass/kroxylicious.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ $primary: $kroxy-light-green;
1919
$secondary: $kroxy-dark-green;
2020
$dark: $kroxy-dark;
2121
$light: $kroxy-light;
22+
$code-color: #b1266b;
2223

2324
@import "./bootstrap/scss/variables";
2425
@import "./bootstrap/scss/variables-dark";

overview.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ toc: true
77

88
This page provides an overview of how Kroxylicious works. For more details, please refer to the [documentation](https://kroxylicious.io/docs/v0.6.0/).
99

10-
#### What is Kroxylicious?
10+
# What is Kroxylicious?
1111

1212
Kroxylicious is an Apache Kafka&#174; protocol-aware proxy. It can be used to layer uniform behaviours onto a
1313
Kafka based system in areas such as data-governance, security, policy enforcement and audit without needing to
@@ -32,7 +32,7 @@ A key concept in Kroxylicious is the Filter. It is these that layer additional
3232
|:---------------------------------------------------:|
3333
| *Overview* |
3434

35-
##### Filters
35+
## Filters
3636

3737
The Filter is at the heart of Kroxylicious. Filters intercept [Kafka RPCs](https://kafka.apache.org/protocol.html)
3838
as they travel through the proxy. Filters can observe or transform the RPC, depending on the needs of the use-case.
@@ -47,7 +47,7 @@ that lets you build custom filters, to fit your own use-case.
4747
| *Request/Response Filtering* |
4848

4949

50-
##### Filter Chains
50+
## Filter Chains
5151

5252
Filters are composable, meaning you can chain filters together to build complex behaviours from simpler units.
5353

@@ -58,7 +58,7 @@ audit filter to suit the requirements of your use-case.
5858
|:----------------------------------------------------------:|
5959
| *Filter Chains* |
6060

61-
##### Performance
61+
## Performance
6262

6363
Kroxylicious is careful to decode only the Kafka RPCs that the filters actually need to process. If no filter is
6464
interested in a particular RPC, its bytes will pass straight through Kroxylicious. This approach helps keep Kroxylicious

0 commit comments

Comments
 (0)