Skip to content

Commit cb57ff3

Browse files
dharmabumsteadScott ButlerDeflaimun
authored
docs: getting started revamp + tutorial use cases move (#891)
Co-authored-by: Scott Butler <dharmabumstead@Scotts-MBP.localdomain> Co-authored-by: Paulo Borges <paulohtb@hotmail.com>
1 parent 523a018 commit cb57ff3

File tree

73 files changed

+316
-276
lines changed

Some content is hidden

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

73 files changed

+316
-276
lines changed

‎docs/.vuepress/configs/navbar.ts‎

Lines changed: 50 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,55 @@
1-
import type {NavbarOptions} from "vuepress-theme-hope";
2-
import {instance as ver} from "../lib/versioning";
1+
import type { NavbarOptions } from "vuepress-theme-hope";
2+
import { instance as ver } from "../lib/versioning";
33

44
export const navbarEn: NavbarOptions = [
5-
{
6-
text: "Getting Started",
7-
link: "/getting-started/introduction.html",
8-
icon: "hugeicons:start-up-02"
9-
},
10-
{
11-
text: "Kurrent Cloud",
12-
link: "/cloud/introduction",
13-
icon: "hugeicons:cloud"
14-
},
15-
{
16-
text: "KurrentDB",
17-
icon: "ion:server-outline",
5+
{
6+
text: "Getting Started",
7+
link: "/getting-started/introduction.html",
8+
},
9+
{
10+
text: "Kurrent Cloud",
11+
link: "/cloud/introduction",
12+
},
13+
{
14+
text: "KurrentDB",
15+
children: [
16+
{ text: "Current", children: ver.linksFor("server", false) },
17+
{ text: "Deprecated", children: ver.linksFor("server", true) },
18+
{
19+
text: "Kubernetes Operator",
20+
children: ver.linksFor("kubernetes-operator", false),
21+
},
22+
],
23+
},
24+
{
25+
text: "Clients & APIs",
26+
children: [
27+
{
28+
text: "Clients",
1829
children: [
19-
{text: "Current", children: ver.linksFor("server", false)},
20-
{text: "Deprecated", children: ver.linksFor("server", true)},
21-
{text: "Kubernetes Operator", children: ver.linksFor("kubernetes-operator", false)},
22-
]
23-
},
24-
{
25-
text: "Clients & APIs",
26-
icon: "material-symbols:sdk",
27-
children: [
28-
{text: "Clients", children: [{text: "KurrentDB clients", link: "/clients/grpc/getting-started"}]},
29-
{text: "HTTP API", children: ver.linksFor("http-api", false)},
30-
{text: "Deprecated", children: [{text: "Legacy TCP clients", link: "/clients/tcp/"}]},
31-
]
32-
},
30+
{ text: "KurrentDB clients", link: "/clients/grpc/getting-started" },
31+
],
32+
},
33+
{ text: "HTTP API", children: ver.linksFor("http-api", false) },
34+
{
35+
text: "Deprecated",
36+
children: [{ text: "Legacy TCP clients", link: "/clients/tcp/" }],
37+
},
38+
],
39+
},
3340

34-
{
35-
text: "Resources",
36-
icon: "material-symbols:support",
37-
children: [
38-
{text: "Community forum", link: "https://discuss.kurrent.io/"},
39-
{text: "Community Discord ", link: "https://discord.gg/Phn9pmCw3t"},
40-
{text: "Blogs", link: "https://www.kurrent.io/blog"},
41-
{text: "Webinars", link: "https://www.kurrent.io/webinars"},
42-
{text: "Kurrent Academy", link: "https://academy.kurrent.io"}
43-
]
44-
}
41+
{
42+
text: "Developer Resources",
43+
children: [
44+
{
45+
text: "Tutorials & Use cases",
46+
link: "/dev-center/",
47+
},
48+
{ text: "Community forum", link: "https://discuss.kurrent.io/" },
49+
{ text: "Community Discord ", link: "https://discord.gg/Phn9pmCw3t" },
50+
{ text: "Blogs", link: "https://www.kurrent.io/blog" },
51+
{ text: "Webinars", link: "https://www.kurrent.io/webinars" },
52+
{ text: "Kurrent Academy", link: "https://academy.kurrent.io" },
53+
],
54+
},
4555
];

‎docs/.vuepress/configs/sidebar.ts‎

Lines changed: 19 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -3,135 +3,42 @@ import { instance as ver } from "../lib/versioning";
33

44
export const sidebarEn: EsSidebarOptions = {
55
"/getting-started/": [
6+
67
{
7-
text: "Quickstart",
8-
link: "/getting-started/quickstart/",
8+
text: "Welcome",
9+
link: "/getting-started/introduction.md",
910
group: "Getting Started",
1011
},
1112
{
12-
text: "Introduction",
13-
link: "/getting-started/introduction.md",
13+
text: "The Kurrent Ecosystem",
14+
link: "/getting-started/kurrent-ecosystem.md",
1415
group: "Getting Started",
1516
},
1617
{
17-
text: "Concepts",
18-
link: "/getting-started/concepts.md",
18+
text: "Why Kurrent?",
19+
link: "/getting-started/kurrent-why.md",
1920
group: "Getting Started",
2021
},
2122
{
22-
text: "Features",
23-
link: "/getting-started/features.md",
23+
text: "Kurrent Concepts",
24+
link: "/getting-started/concepts.md",
2425
group: "Getting Started",
25-
},
26-
{
27-
text: "Use Cases",
28-
collapsible: true,
29-
expanded: false,
30-
group: "Use Cases",
31-
children: [
32-
{
33-
text: "Mix-and-Match Database",
34-
collapsible: true,
35-
expanded: false,
36-
group: "Mix-and-Match Database",
37-
children: [
38-
{
39-
text: "Overview",
40-
link: "/getting-started/use-cases/mix-and-match-database/introduction.md"
41-
},
42-
{
43-
text: "Tutorial",
44-
collapsible: true,
45-
expanded: false,
46-
group: "Mix-and-Match Database Tutorial",
47-
children: [
48-
{
49-
text: "Introduction",
50-
link: "/getting-started/use-cases/mix-and-match-database/tutorial-intro.md"
51-
},
52-
"/getting-started/use-cases/mix-and-match-database/tutorial-1.md",
53-
"/getting-started/use-cases/mix-and-match-database/tutorial-2.md",
54-
"/getting-started/use-cases/mix-and-match-database/tutorial-3.md",
55-
"/getting-started/use-cases/mix-and-match-database/tutorial-4.md"
56-
]
57-
}
58-
]
59-
},
60-
{
61-
text: "Outbox Out-of-the-Box",
62-
collapsible: true,
63-
expanded: false,
64-
group: "Outbox Out-of-the-Box",
65-
children: [
66-
{
67-
text: "Overview",
68-
link: "/getting-started/use-cases/outbox/introduction.md"
69-
},
70-
{
71-
text: "Tutorial",
72-
collapsible: true,
73-
expanded: false,
74-
group: "Outbox Tutorial",
75-
children: [
76-
{
77-
text: "Introduction",
78-
link: "/getting-started/use-cases/outbox/tutorial-intro.md"
79-
},
80-
"/getting-started/use-cases/outbox/tutorial-1.md",
81-
"/getting-started/use-cases/outbox/tutorial-2.md",
82-
"/getting-started/use-cases/outbox/tutorial-3.md",
83-
"/getting-started/use-cases/outbox/tutorial-4.md",
84-
"/getting-started/use-cases/outbox/tutorial-summary.md"
85-
]
86-
}
87-
]
88-
},
89-
{
90-
text: "Time Travel",
91-
collapsible: true,
92-
expanded: false,
93-
group: "Time Travel",
94-
children: [
95-
{
96-
text: "Overview",
97-
link: "/getting-started/use-cases/time-travel/introduction.md"
98-
},
99-
{
100-
text: "Tutorial",
101-
collapsible: true,
102-
expanded: false,
103-
group: "Time Travel Tutorial",
104-
children: [
105-
{
106-
text: "Introduction",
107-
link: "/getting-started/use-cases/time-travel/tutorial-intro.md"
108-
},
109-
"/getting-started/use-cases/time-travel/tutorial-1.md",
110-
"/getting-started/use-cases/time-travel/tutorial-2.md",
111-
"/getting-started/use-cases/time-travel/tutorial-3.md",
112-
"/getting-started/use-cases/time-travel/tutorial-4.md",
113-
"/getting-started/use-cases/time-travel/tutorial-5.md",
114-
"/getting-started/use-cases/time-travel/tutorial-summary.md"
115-
]
116-
}
117-
]
118-
}
119-
]
12026
},
12127
{
122-
text: "Evaluate",
123-
collapsible: true,
124-
expanded: false,
28+
text: "Self-Guided Demo",
29+
link: "/getting-started/quickstart/",
12530
group: "Getting Started",
126-
children: [
127-
"/getting-started/evaluate/business-process-support.md",
128-
"/getting-started/evaluate/state-vs-event-based-data-model.md",
129-
"/getting-started/evaluate/data-pipeline.md",
130-
]
131-
},
31+
},
32+
{
33+
text: "Going Further",
34+
link: "/getting-started/going-further.md",
35+
group: "Getting Started",
36+
},
37+
13238
],
13339
"/clients/grpc/": "structure",
13440
"/cloud/": "structure",
13541
...ver.getSidebars(),
13642
"/clients/tcp/dotnet/21.2/": "structure",
43+
"/dev-center/":"structure"
13744
};

‎docs/.vuepress/public/_redirects‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,3 +301,27 @@
301301
# ######################
302302

303303
/resources/* / 301
304+
305+
306+
307+
# ######################
308+
# Tutorial and Use Case Redirects
309+
# ######################
310+
311+
# Tutorial files moved from tutorials/ to dev-center/tutorials/
312+
/tutorials/* /dev-center/tutorials/:splat 301
313+
314+
# Use case tutorial-N.md files moved into /tutorial/ subfolder
315+
/getting-started/use-cases/*/tutorial-1.md /dev-center/use-cases/:splat/tutorial/tutorial-1.md 301
316+
/getting-started/use-cases/*/tutorial-1.html /dev-center/use-cases/:splat/tutorial/tutorial-1.html 301
317+
/getting-started/use-cases/*/tutorial-2.md /dev-center/use-cases/:splat/tutorial/tutorial-2.md 301
318+
/getting-started/use-cases/*/tutorial-2.html /dev-center/use-cases/:splat/tutorial/tutorial-2.html 301
319+
/getting-started/use-cases/*/tutorial-3.md /dev-center/use-cases/:splat/tutorial/tutorial-3.md 301
320+
/getting-started/use-cases/*/tutorial-3.html /dev-center/use-cases/:splat/tutorial/tutorial-3.html 301
321+
/getting-started/use-cases/*/tutorial-4.md /dev-center/use-cases/:splat/tutorial/tutorial-4.md 301
322+
/getting-started/use-cases/*/tutorial-4.html /dev-center/use-cases/:splat/tutorial/tutorial-4.html 301
323+
/getting-started/use-cases/*/tutorial-5.md /dev-center/use-cases/:splat/tutorial/tutorial-5.md 301
324+
/getting-started/use-cases/*/tutorial-5.html /dev-center/use-cases/:splat/tutorial/tutorial-5.html 301
325+
326+
# Other use case files stay in the root (introduction.md, tutorial-summary.md, etc.)
327+
/getting-started/use-cases/* /dev-center/use-cases/:splat 301

‎docs/dev-center/README.md‎

Lines changed: 9 additions & 0 deletions

docs/tutorials/Auto-Scavenge.md renamed to docs/dev-center/tutorials/Auto-Scavenge.md

docs/tutorials/Encryption-At-Rest.md renamed to docs/dev-center/tutorials/Encryption-At-Rest.md

docs/tutorials/HTTP_Connector.md renamed to docs/dev-center/tutorials/HTTP_Connector.md

docs/tutorials/Kafka_Sink.md renamed to docs/dev-center/tutorials/Kafka_Sink.md

Lines changed: 2 additions & 2 deletions

docs/tutorials/MongoDB_Sink.md renamed to docs/dev-center/tutorials/MongoDB_Sink.md

Lines changed: 1 addition & 1 deletion

docs/tutorials/RabbitMQ_Sink.md renamed to docs/dev-center/tutorials/RabbitMQ_Sink.md

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)