Skip to content

Commit b9fb729

Browse files
tombentleytombentley
authored
Rework the website (#141)
* Rework navigation, add downloads and documentation * Use separate YAML file for each release (`_data/release`) and collection of docs in a release (`_data/documentation`) * Warning about unreleased versions * Support explicit ranking of docs * Use permalinks for SNAPSHOT docs Signed-off-by: Tom Bentley <[email protected]>
1 parent 26281a4 commit b9fb729

File tree

90 files changed

+8674
-37
lines changed

Some content is hidden

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

90 files changed

+8674
-37
lines changed

‎_data/documentation/0_10_0.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
docs:
2+
- title: Quick start
3+
description: Start here if you're just getting started with Kroxylicious.
4+
path: /quickstarts
5+
- title: Proxy Guide
6+
description: Describes how to deploy and operate the proxy on "bare metal".
7+
path: /docs/v0.10.0/

‎_data/documentation/0_11_0.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
docs:
2+
- title: Quick start
3+
description: Start here if you're just getting started with Kroxylicious.
4+
path: /quickstarts
5+
- title: Proxy Guide
6+
description: Describes how to deploy and operate the proxy on "bare metal".
7+
path: html/proxy/
8+
- title: Operator Guide
9+
description: Describes how to deploy and operate the proxy on Kubernetes.
10+
path: html/operator/
11+
- title: Developer Guide
12+
description: Describes how to write Kroxylicious plugins using the Java programming language.
13+
path: html/developer/

‎_data/documentation/0_12_0.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
docs:
2+
- title: Proxy quick start
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
path: /quickstarts
5+
- title: Developer quick start
6+
description: Start here if you're developing a filter for the first time.
7+
path: /quickstarts
8+
- title: Proxy Guide
9+
description: Describes how to deploy and operate the proxy on "bare metal".
10+
path: html/proxy/
11+
- title: Operator Guide
12+
description: Describes how to deploy and operate the proxy on Kubernetes.
13+
path: html/operator/
14+
- title: Developer Guide
15+
description: Describes how to write Kroxylicious plugins using the Java programming language.
16+
path: html/developer/
17+
- title: Javadoc
18+
description: The Java API documentation.
19+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/latest/index.html
20+

‎_data/documentation/0_13_0.yaml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
docs:
2+
- title: Proxy quickstart
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
tags:
5+
- proxy
6+
path: /quickstarts
7+
rank: '000'
8+
- title: Proxy guide
9+
description: "Covers using the proxy, including configuration, security and operation."
10+
tags:
11+
- proxy
12+
rank: '010'
13+
path: html/kroxylicious-proxy
14+
- title: Record Encryption Guide
15+
description: "Covers using the record encryption filter, including configuration,\
16+
\ security and operation."
17+
tags:
18+
- filter
19+
rank: '020'
20+
path: html/record-encryption-guide
21+
- title: Kroxylicious Operator for Kubernetes
22+
description: Describes how to deploy and run the Proxy in a Kubernetes environment
23+
using the Kroxylicious Operator
24+
tags:
25+
- kubernetes
26+
rank: '020'
27+
path: html/kroxylicious-operator
28+
- title: Developer quickstart
29+
description: Start here if you're developing a filter for the first time.
30+
tags:
31+
- developer
32+
path: /quickstarts
33+
rank: '031'
34+
- title: Kroxylicious Developer guide
35+
description: Covers writing plugins for the proxy in the Java programming language
36+
tags:
37+
- developer
38+
rank: '032'
39+
path: html/developer-guide
40+
- title: Kroxylicious Javadocs
41+
description: The Java API documentation.
42+
tags:
43+
- developer
44+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/0.13.0/index.html
45+
rank: '033'

‎_data/documentation/0_14_0-SNAPSHOT.yaml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
docs:
2+
- title: Proxy quickstart
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
tags:
5+
- proxy
6+
path: /quickstarts
7+
rank: '000'
8+
- title: Proxy guide
9+
description: "Covers using the proxy, including configuration, security and operation."
10+
tags:
11+
- proxy
12+
rank: '010'
13+
path: html/kroxylicious-proxy
14+
- title: Record Encryption Guide
15+
description: "Covers using the record encryption filter, including configuration,\
16+
\ security and operation."
17+
tags:
18+
- filter
19+
rank: '020'
20+
path: html/record-encryption-guide
21+
- title: Kroxylicious Operator for Kubernetes
22+
description: Describes how to deploy and run the Proxy in a Kubernetes environment
23+
using the Kroxylicious Operator
24+
tags:
25+
- kubernetes
26+
rank: '020'
27+
path: html/kroxylicious-operator
28+
- title: Developer quickstart
29+
description: Start here if you're developing a filter for the first time.
30+
tags:
31+
- developer
32+
path: /quickstarts
33+
rank: '031'
34+
- title: Kroxylicious Developer guide
35+
description: Covers writing plugins for the proxy in the Java programming language
36+
tags:
37+
- developer
38+
rank: '032'
39+
path: html/developer-guide
40+
- title: Kroxylicious Javadocs
41+
description: The Java API documentation.
42+
tags:
43+
- developer
44+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/0.14.0-SNAPSHOT/index.html
45+
rank: '033'

‎_data/documentation/0_1_0.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
docs:
2+
- title: Quick start
3+
description: Start here if you're just getting started with Kroxylicious.
4+
path: /quickstarts
5+
- title: Proxy Guide
6+
description: Describes how to deploy and operate the proxy on "bare metal".
7+
path: /docs/v0.1.0/

‎_data/documentation/0_2_0.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
docs:
2+
- title: Quick start
3+
description: Start here if you're just getting started with Kroxylicious.
4+
path: /quickstarts
5+
- title: Proxy Guide
6+
description: Describes how to deploy and operate the proxy on "bare metal".
7+
path: /docs/v0.2.0/

‎_data/documentation/0_3_0.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
docs:
2+
- title: Quick start
3+
description: Start here if you're just getting started with Kroxylicious.
4+
path: /quickstarts
5+
- title: Proxy Guide
6+
description: Describes how to deploy and operate the proxy on "bare metal".
7+
path: /docs/v0.3.0/

‎_data/documentation/0_4_0.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
docs:
2+
- title: Quick start
3+
description: Start here if you're just getting started with Kroxylicious.
4+
path: /quickstarts
5+
- title: Proxy Guide
6+
description: Describes how to deploy and operate the proxy on "bare metal".
7+
path: /docs/v0.4.0/

‎_data/documentation/0_4_1.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
docs:
2+
- title: Quick start
3+
description: Start here if you're just getting started with Kroxylicious.
4+
path: /quickstarts
5+
- title: Proxy Guide
6+
description: Describes how to deploy and operate the proxy on "bare metal".
7+
path: /docs/v0.4.1/

0 commit comments

Comments
 (0)