Skip to content

Commit c831b77

Browse files
SamBarkerk-wall
authored andcommitted
Prepare v0.13.0 release documentation
Signed-off-by: SamBarker <[email protected]>
1 parent 4430d7f commit c831b77

File tree

132 files changed

+10068
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

132 files changed

+10068
-0
lines changed

_data/kroxylicious.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
versions:
22
- title: 'Development'
33
url: '/kroxylicious'
4+
- title: 'v0.13.0'
5+
url: '/docs/v0.13.0/'
46
- title: 'v0.12.0'
57
url: '/docs/v0.12.0/'
68
subsections:
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
// AsciiDoc settings
2+
:data-uri!:
3+
:doctype: book
4+
:experimental:
5+
:idprefix:
6+
:imagesdir: images
7+
:numbered:
8+
:sectanchors!:
9+
:sectnums:
10+
:source-highlighter: highlight.js
11+
:toc: left
12+
:linkattrs:
13+
:toclevels: 2
14+
:icons: font
15+
16+
//Latest version
17+
:KroxyliciousVersion: 0.13
18+
:gitRef: releases/tag/v0.13.0
19+
:ApicurioVersion: 2.6.x
20+
:KubernetesVersionMinimum: 1.31
21+
:OpenShiftVersionMinimum: 4.18
22+
23+
:OperatorDownloadUrl: https://github.com/kroxylicious/kroxylicious/releases[GitHub releases page^]
24+
:OperatorAssetZipFileName: kroxylicious-operator-{KroxyliciousVersion}.zip
25+
:OperatorAssetTgzFileName: kroxylicious-operator-{KroxyliciousVersion}.tar.gz
26+
27+
//Proxy links
28+
:github: https://github.com/kroxylicious/kroxylicious
29+
:github-releases: https://github.com/kroxylicious/kroxylicious/{gitRef}
30+
:github-issues: https://github.com/kroxylicious/kroxylicious/issues
31+
:api-javadoc: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/{KroxyliciousVersion}
32+
:kms-api-javadoc: https://javadoc.io/doc/io.kroxylicious/kroxylicious-kms/{KroxyliciousVersion}
33+
:encryption-api-javadoc: https://javadoc.io/doc/io.kroxylicious/kroxylicious-encryption/{KroxyliciousVersion}
34+
:start-script: https://github.com/kroxylicious/kroxylicious/blob/{gitRef}/kroxylicious-app/src/assembly/kroxylicious-start.sh
35+
36+
//Kubernetes links
37+
:KubeTools: link:https://kubernetes.io/docs/tasks/tools/[Install Tools^]
38+
39+
//Kafka links
40+
:ApacheKafkaSite: https://kafka.apache.org[Apache Kafka website^]
41+
:kafka-protocol: https://kafka.apache.org/protocol.html
42+
43+
//java links
44+
:java-17-javadoc: https://docs.oracle.com/en/java/javase/17/docs/api
45+
:java-17-specs: https://docs.oracle.com/en/java/javase/17/docs/specs
46+
:tlsProtocolNames: https://docs.oracle.com/en/java/javase/17/docs/specs/security/standard-names.html#sslcontext-algorithms
47+
:cipherSuiteNames: https://docs.oracle.com/en/java/javase/21/docs/specs/security/standard-names.html#jsse-cipher-suite-names
48+
49+
//Vault links
50+
:hashicorp-vault: https://developer.hashicorp.com/vault
51+
52+
//Fortanix DSM links
53+
:fortanix-dsm: https://www.fortanix.com/platform/data-security-manager
54+
:fortanix-support: https://support.fortanix.com/
55+
56+
//AWS links
57+
:aws: https://docs.aws.amazon.com/
58+
59+
// Apicurio links
60+
:apicurio-docs: https://www.apicur.io/registry/docs/apicurio-registry/{ApicurioVersion}/
61+
62+
// Kubernetes links
63+
:KubernetesSite: https://kubernetes.io/
64+
:OperatorPattern: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/
65+
66+
// Java Operator SDK links
67+
:josdk: https://javaoperatorsdk.io/
68+
:josdk-metrics: https://github.com/operator-framework/java-operator-sdk/blob/v5.0.4/docs/content/en/docs/features/_index.md#operator-sdk-metrics
69+
70+
// Conditional inclusion flags
71+
// (note: we control optional inclusion with ifdefs/ifndefs directives, so the value of the attribute is irrelevant)
72+
:include-fortanix-dsm-kms: 1
73+
:include-aws-kms-service-config-identity-ec2-metadata: 1
74+
:include-platform-bare-metal: 1
75+
// We're not ready to enable OLM yet
76+
//:include-olm: 1
77+
//:OpenShiftOnly: 1
78+
79+
//API stability markers.
80+
:unstable-api-version: denoted by a major version 0
81+
:stable-api-version: version 1.0.0
82+
83+
// We have a development document (docs/index.adoc) that sits one level higher than the guides, so we need a way to override DocRoot.
84+
ifndef::DocRoot[:DocRoot: ..]
85+
:ProxyGuide: link:{DocRoot}/kroxylicious-proxy/[Kroxylicious Proxy guide]
86+
:RecordEncryptionGuide: link:{DocRoot}/record-encryption-guide/[Kroxylicious Record Encryption guide]
87+
:DeveloperGuide: link:{DocRoot}/developer-guide/[Kroxylicious Developer guide]
88+
:OperatorGuide: link:{DocRoot}/kroxylicious-operator/[Kroxylicious Operator for Kubernetes guide]

0 commit comments

Comments
 (0)