Skip to content

Commit 707f4fa

Browse files
tombentleytombentley
authored
Rework the quickstarts (#152)
* Move them from `/quickstarts` to `/doc/quickstart/*/index.markdown` * Drop the idea of having a tab-per-quickstart. Instead give them each their own page. * Tweak the scss so the code blocks aren't so huge * Use markdown syntax for headings * Drop the <br/> Signed-off-by: Tom Bentley <[email protected]>
1 parent e031a4b commit 707f4fa

24 files changed

+280
-187
lines changed

‎_config.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,6 @@ include:
6767
collections:
6868
use_cases:
6969
output: false
70-
quickstarts:
71-
output: false
7270

7371
keep_files:
7472
- images

‎_data/documentation/0_10_0.yaml

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
docs:
2-
- title: Quick start
3-
description: Start here if you're just getting started with Kroxylicious.
4-
path: /quickstarts
2+
- title: Proxy quick start
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
tags:
5+
- proxy
6+
path: /docs/quickstart/deploy/
7+
rank: '000'
58
- title: Proxy Guide
69
description: Describes how to deploy and operate the proxy on "bare metal".
710
path: /docs/v$(VERSION)/
11+
rank: '010'
12+
- title: Developer quick start
13+
description: Start here if you're developing a filter for the first time.
14+
tags:
15+
- developer
16+
path: /docs/quickstart/develop/
17+
rank: '031'
818
- title: Javadoc
919
description: The Java API documentation.
10-
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
20+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
21+
rank: '033'

‎_data/documentation/0_11_0.yaml

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
docs:
2-
- title: Quick start
3-
description: Start here if you're just getting started with Kroxylicious.
4-
path: /quickstarts
2+
- title: Proxy quick start
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
tags:
5+
- proxy
6+
path: /docs/quickstart/deploy/
7+
rank: '000'
8+
- title: Developer quick start
9+
description: Start here if you're developing a filter for the first time.
10+
tags:
11+
- developer
12+
path: /docs/quickstart/develop/
13+
rank: '031'
514
- title: Proxy Guide
615
description: Describes how to deploy and operate the proxy on "bare metal".
716
path: /docs/v$(VERSION)/kroxylicious-proxy/
@@ -11,6 +20,8 @@ docs:
1120
- title: Developer Guide
1221
description: Describes how to write Kroxylicious plugins using the Java programming language.
1322
path: html/developer/
23+
rank: '032'
1424
- title: Javadoc
1525
description: The Java API documentation.
16-
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
26+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
27+
rank: '033'

‎_data/documentation/0_12_0.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
docs:
22
- title: Proxy quick start
33
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
4+
tags:
5+
- proxy
6+
path: /docs/quickstart/deploy/
7+
rank: '000'
88
- title: Proxy Guide
99
description: Describes how to deploy and operate the proxy on "bare metal".
1010
path: /docs/v$(VERSION)/kroxylicious-proxy/
11+
rank: '010'
12+
- title: Developer quick start
13+
description: Start here if you're developing a filter for the first time.
14+
tags:
15+
- developer
16+
path: /docs/quickstart/develop/
17+
rank: '031'
1118
- title: Javadoc
1219
description: The Java API documentation.
1320
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
21+
rank: '033'
1422

‎_data/documentation/0_13_0.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
docs:
2-
- title: Proxy quickstart
2+
- title: Proxy quick start
33
description: Start here if you're experimenting with the proxy for the first time.
44
tags:
55
- proxy
6-
path: /quickstarts
6+
path: /docs/quickstart/deploy/
77
rank: '000'
88
- title: Proxy guide
99
description: "Covers using the proxy, including configuration, security and operation."
@@ -25,11 +25,11 @@ docs:
2525
- kubernetes
2626
rank: '020'
2727
path: html/kroxylicious-operator
28-
- title: Developer quickstart
28+
- title: Developer quick start
2929
description: Start here if you're developing a filter for the first time.
3030
tags:
3131
- developer
32-
path: /quickstarts
32+
path: /docs/quickstart/develop/
3333
rank: '031'
3434
- title: Kroxylicious Developer guide
3535
description: Covers writing plugins for the proxy in the Java programming language

‎_data/documentation/0_14_0-SNAPSHOT.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
docs:
2-
- title: Proxy quickstart
2+
- title: Proxy quick start
33
description: Start here if you're experimenting with the proxy for the first time.
44
tags:
55
- proxy
@@ -25,7 +25,7 @@ docs:
2525
- kubernetes
2626
rank: '020'
2727
path: html/kroxylicious-operator
28-
- title: Developer quickstart
28+
- title: Developer quick start
2929
description: Start here if you're developing a filter for the first time.
3030
tags:
3131
- developer

‎_data/documentation/0_1_0.yaml

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
docs:
2-
- title: Quick start
3-
description: Start here if you're just getting started with Kroxylicious.
4-
path: /quickstarts
2+
- title: Proxy quick start
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
tags:
5+
- proxy
6+
path: /docs/quickstart/deploy/
7+
rank: '000'
58
- title: Proxy Guide
69
description: Describes how to deploy and operate the proxy on "bare metal".
710
path: /docs/v$(VERSION)/
11+
rank: '010'
12+
- title: Developer quick start
13+
description: Start here if you're developing a filter for the first time.
14+
tags:
15+
- developer
16+
path: /docs/quickstart/develop/
17+
rank: '031'
818
- title: Javadoc
919
description: The Java API documentation.
10-
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
20+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
21+
rank: '033'

‎_data/documentation/0_2_0.yaml

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
docs:
2-
- title: Quick start
3-
description: Start here if you're just getting started with Kroxylicious.
4-
path: /quickstarts
2+
- title: Proxy quick start
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
tags:
5+
- proxy
6+
path: /docs/quickstart/deploy/
7+
rank: '000'
58
- title: Proxy Guide
69
description: Describes how to deploy and operate the proxy on "bare metal".
710
path: /docs/v$(VERSION)/
11+
rank: '010'
12+
- title: Developer quick start
13+
description: Start here if you're developing a filter for the first time.
14+
tags:
15+
- developer
16+
path: /docs/quickstart/develop/
17+
rank: '031'
818
- title: Javadoc
919
description: The Java API documentation.
10-
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
20+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
21+
rank: '033'

‎_data/documentation/0_3_0.yaml

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
docs:
2-
- title: Quick start
3-
description: Start here if you're just getting started with Kroxylicious.
4-
path: /quickstarts
2+
- title: Proxy quick start
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
tags:
5+
- proxy
6+
path: /docs/quickstart/deploy/
7+
rank: '000'
58
- title: Proxy Guide
69
description: Describes how to deploy and operate the proxy on "bare metal".
710
path: /docs/v$(VERSION)/
11+
rank: '010'
12+
- title: Developer quick start
13+
description: Start here if you're developing a filter for the first time.
14+
tags:
15+
- developer
16+
path: /docs/quickstart/develop/
17+
rank: '031'
818
- title: Javadoc
919
description: The Java API documentation.
10-
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
20+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
21+
rank: '033'

‎_data/documentation/0_4_0.yaml

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
docs:
2-
- title: Quick start
3-
description: Start here if you're just getting started with Kroxylicious.
4-
path: /quickstarts
2+
- title: Proxy quick start
3+
description: Start here if you're experimenting with the proxy for the first time.
4+
tags:
5+
- proxy
6+
path: /docs/quickstart/deploy/
7+
rank: '000'
58
- title: Proxy Guide
69
description: Describes how to deploy and operate the proxy on "bare metal".
710
path: /docs/v$(VERSION)/
11+
rank: '010'
12+
- title: Developer quick start
13+
description: Start here if you're developing a filter for the first time.
14+
tags:
15+
- developer
16+
path: /docs/quickstart/develop/
17+
rank: '031'
818
- title: Javadoc
919
description: The Java API documentation.
10-
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
20+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/$(VERSION)/index.html
21+
rank: '033'

0 commit comments

Comments
 (0)