Skip to content

Commit 3ae1796

Browse files
committed
Add Security and Governance filter categories
Added two new filter categories to better organise documentation: - Security: for encryption, authentication, and authorisation guides - Governance: for compliance and validation guides Changes: - Added 'security' tag to: Proxy guide, Record Encryption quickstart/guide, OAuth Bearer Validation, SASL Inspection, and Authorization guides - Added 'governance' tag to: Record Validation Guide - Removed overly-specific 'record-encryption' and 'encryption-at-rest' tags - Added Security and Governance filter buttons with shield-lock and check-square-fill icons respectively - Updated icon mapping and CSS border styles for new categories - Applied changes to versions 0.16.0 through 0.19.0 Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 6e3f480 commit 3ae1796

7 files changed

Lines changed: 45 additions & 11 deletions

File tree

_data/documentation/0_16_0.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ docs:
99
description: "Covers using the proxy, including configuration, security and operation."
1010
tags:
1111
- proxy
12+
- security
1213
rank: '010'
1314
path: html/kroxylicious-proxy
1415
- title: Record Encryption quickstart
1516
description: Shows how to use the proxy to provide an encryption at rest solution
1617
for Apache Kafka
1718
tags:
18-
- record-encryption
19-
- encryption-at-rest
19+
- security
2020
rank: '011'
2121
path: html/record-encryption-quickstart
2222
- title: Kroxylicious Operator for Kubernetes
@@ -31,12 +31,14 @@ docs:
3131
\ security and operation."
3232
tags:
3333
- filter
34+
- security
3435
rank: '020'
3536
path: html/record-encryption-guide
3637
- title: Record Validation Guide
3738
description: Covers using the record validation filter.
3839
tags:
3940
- filter
41+
- governance
4042
rank: '021'
4143
path: html/record-validation-guide
4244
- title: Multi-tenancy Guide
@@ -49,6 +51,7 @@ docs:
4951
description: Covers using the Oauth Bearer validation filter.
5052
tags:
5153
- filter
54+
- security
5255
rank: '023'
5356
path: html/oauth-bearer-validation
5457
- title: Developer Quick Start

_data/documentation/0_17_0.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ docs:
99
description: "Covers using the proxy, including configuration, security and operation."
1010
tags:
1111
- proxy
12+
- security
1213
rank: '010'
1314
path: html/kroxylicious-proxy
1415
- title: Record Encryption quickstart
1516
description: Shows how to use the proxy to provide an encryption at rest solution
1617
for Apache Kafka
1718
tags:
18-
- record-encryption
19-
- encryption-at-rest
19+
- security
2020
rank: '011'
2121
path: html/record-encryption-quickstart
2222
- title: Kroxylicious Operator for Kubernetes
@@ -31,12 +31,14 @@ docs:
3131
\ security and operation."
3232
tags:
3333
- filter
34+
- security
3435
rank: '020'
3536
path: html/record-encryption-guide
3637
- title: Record Validation Guide
3738
description: Covers using the record validation filter.
3839
tags:
3940
- filter
41+
- governance
4042
rank: '021'
4143
path: html/record-validation-guide
4244
- title: Multi-tenancy Guide
@@ -49,12 +51,14 @@ docs:
4951
description: Covers using the SASL Inspection filter.
5052
tags:
5153
- filter
54+
- security
5255
rank: '023'
5356
path: html/sasl-inspection-guide
5457
- title: Oauth Bearer Validation Guide
5558
description: Covers using the Oauth Bearer validation filter.
5659
tags:
5760
- filter
61+
- security
5862
rank: '023'
5963
path: html/oauth-bearer-validation
6064
- title: Developer Quick Start

_data/documentation/0_17_1.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ docs:
99
description: "Covers using the proxy, including configuration, security and operation."
1010
tags:
1111
- proxy
12+
- security
1213
rank: '010'
1314
path: html/kroxylicious-proxy
1415
- title: Record Encryption quickstart
1516
description: Shows how to use the proxy to provide an encryption at rest solution
1617
for Apache Kafka
1718
tags:
18-
- record-encryption
19-
- encryption-at-rest
19+
- security
2020
rank: '011'
2121
path: html/record-encryption-quickstart
2222
- title: Kroxylicious Operator for Kubernetes
@@ -31,12 +31,14 @@ docs:
3131
\ security and operation."
3232
tags:
3333
- filter
34+
- security
3435
rank: '020'
3536
path: html/record-encryption-guide
3637
- title: Record Validation Guide
3738
description: Covers using the record validation filter.
3839
tags:
3940
- filter
41+
- governance
4042
rank: '021'
4143
path: html/record-validation-guide
4244
- title: Multi-tenancy Guide
@@ -49,12 +51,14 @@ docs:
4951
description: Covers using the SASL Inspection filter.
5052
tags:
5153
- filter
54+
- security
5255
rank: '023'
5356
path: html/sasl-inspection-guide
5457
- title: Oauth Bearer Validation Guide
5558
description: Covers using the Oauth Bearer validation filter.
5659
tags:
5760
- filter
61+
- security
5862
rank: '023'
5963
path: html/oauth-bearer-validation
6064
- title: Developer Quick Start

_data/documentation/0_18_0.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ docs:
99
description: "Covers using the proxy, including configuration, security and operation."
1010
tags:
1111
- proxy
12+
- security
1213
rank: '010'
1314
path: html/kroxylicious-proxy
1415
- title: Record Encryption quickstart
1516
description: Shows how to use the proxy to provide an encryption at rest solution
1617
for Apache Kafka
1718
tags:
18-
- record-encryption
19-
- encryption-at-rest
19+
- security
2020
rank: '011'
2121
path: html/record-encryption-quickstart
2222
- title: Kroxylicious Operator for Kubernetes
@@ -31,12 +31,14 @@ docs:
3131
\ security and operation."
3232
tags:
3333
- filter
34+
- security
3435
rank: '020'
3536
path: html/record-encryption-guide
3637
- title: Record Validation Guide
3738
description: Covers using the record validation filter.
3839
tags:
3940
- filter
41+
- governance
4042
rank: '021'
4143
path: html/record-validation-guide
4244
- title: Multi-tenancy Guide
@@ -49,12 +51,14 @@ docs:
4951
description: Covers using the SASL Inspection filter.
5052
tags:
5153
- filter
54+
- security
5255
rank: '023'
5356
path: html/sasl-inspection-guide
5457
- title: Oauth Bearer Validation Guide
5558
description: Covers using the Oauth Bearer validation filter.
5659
tags:
5760
- filter
61+
- security
5862
rank: '023'
5963
path: html/oauth-bearer-validation
6064
- title: Developer Quick Start

_data/documentation/0_19_0.yaml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ docs:
99
description: "Covers using the proxy, including configuration, security and operation."
1010
tags:
1111
- proxy
12+
- security
1213
rank: '010'
1314
path: html/kroxylicious-proxy
1415
- title: Record Encryption quickstart
1516
description: Shows how to use the proxy to provide an encryption at rest solution
1617
for Apache Kafka
1718
tags:
18-
- record-encryption
19-
- encryption-at-rest
19+
- security
2020
rank: '011'
2121
path: html/record-encryption-quickstart
2222
- title: Kroxylicious Operator for Kubernetes
@@ -31,12 +31,14 @@ docs:
3131
\ security and operation."
3232
tags:
3333
- filter
34+
- security
3435
rank: '020'
3536
path: html/record-encryption-guide
3637
- title: Record Validation Guide
3738
description: Covers using the record validation filter.
3839
tags:
3940
- filter
41+
- governance
4042
rank: '021'
4143
path: html/record-validation-guide
4244
- title: Multi-tenancy Guide
@@ -49,18 +51,21 @@ docs:
4951
description: Covers using the Oauth Bearer validation filter.
5052
tags:
5153
- filter
54+
- security
5255
rank: '023'
5356
path: html/oauth-bearer-validation
5457
- title: SASL Inspection Guide
5558
description: Covers using the SASL Inspection filter.
5659
tags:
5760
- filter
61+
- security
5862
rank: '023'
5963
path: html/sasl-inspection-guide
6064
- title: Authorization Guide
6165
description: Covers using the Authorization filter.
6266
tags:
6367
- filter
68+
- security
6469
rank: '024'
6570
path: html/authorization-guide
6671
- title: Developer Quick Start

_layouts/released-documentation.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ <h1 id="page-title" class="fs-3">{{ version }} Documentation</h1>
5353
<button class="btn btn-sm btn-outline-secondary" data-filter="developer">
5454
<i class="bi bi-code-slash"></i> Developer
5555
</button>
56+
<button class="btn btn-sm btn-outline-secondary" data-filter="security">
57+
<i class="bi bi-shield-lock"></i> Security
58+
</button>
59+
<button class="btn btn-sm btn-outline-secondary" data-filter="governance">
60+
<i class="bi bi-check-square-fill"></i> Governance
61+
</button>
5662
</div>
5763
<div class="row row-cols-1 row-cols-md-2 g-4">
5864
{%- for doc in docs_for_release -%}
@@ -73,7 +79,7 @@ <h2 class="card-title fs-4 mb-0 flex-grow-1">
7379
<a href='{{ linkTemplate | replace: "$(VERSION)", version}}'>{{ doc.title }}</a>
7480
</h2>
7581
{%- assign primary_tag = doc.tags[0] -%}
76-
<i class="bi bi-{% if primary_tag == 'proxy' %}cpu{% elsif primary_tag == 'filter' %}puzzle{% elsif primary_tag == 'kubernetes' %}boxes{% elsif primary_tag == 'developer' %}code-slash{% elsif primary_tag == 'record-encryption' or primary_tag == 'encryption-at-rest' %}shield-lock{% else %}file-text{% endif %} text-secondary ms-2" aria-hidden="true"></i>
82+
<i class="bi bi-{% if primary_tag == 'proxy' %}cpu{% elsif primary_tag == 'filter' %}puzzle{% elsif primary_tag == 'kubernetes' %}boxes{% elsif primary_tag == 'developer' %}code-slash{% elsif primary_tag == 'security' %}shield-lock{% elsif primary_tag == 'governance' %}check-square-fill{% else %}file-text{% endif %} text-secondary ms-2" aria-hidden="true"></i>
7783
</div>
7884
<div class="card-body mx-3 my-2">
7985
{{ doc.description }}

_sass/kroxylicious.scss

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,14 @@ b.conum * {
418418
border-bottom-color: rgba($code-color, 0.3);
419419
}
420420

421+
&.doctag-security .card-header {
422+
border-bottom-color: rgba($kroxy-light-green, 0.3);
423+
}
424+
425+
&.doctag-governance .card-header {
426+
border-bottom-color: rgba($kroxy-mid-green, 0.3);
427+
}
428+
421429
.badge {
422430
font-size: 0.7rem;
423431
padding: 0.25rem 0.5rem;

0 commit comments

Comments
 (0)