Skip to content

Commit 975a5a5

Browse files
committed
docs: kurrentdb-operator v1.1.0
Add docs for new features: scheduling constraints and read-only replicas. Also introduce versioning into the kurrentdb-operator docs. Also updates the breadcrumb generation logic: - Eliminate breadcrumb-replacements.json; use README.md with frontmatter instead. Secret json configs to mutate what is in the docs directory is hard to figure out. - If frontmatter's .title is set, use it as-is. Only apply regexes designed for filenames to actual filenames. - Fix some broken frontmatters that were causing issues.
1 parent 4e594dd commit 975a5a5

Some content is hidden

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

48 files changed

+1423
-18
lines changed
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"cloud": "Kurrent Cloud",
3-
"server": "KurrentDB",
4-
"kubernetes-operator": "Kubernetes Operator"
3+
"server": "KurrentDB"
54
}
6-
5+

docs/.vuepress/client.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,10 @@ export default defineClientConfig({
9898
}
9999
}, 0);
100100
});
101-
addDynamicRoute("/server/kubernetes-operator", to => `/server/kubernetes-operator/getting-started/`);
101+
const operatorLatest = __VERSIONS__.all.filter(x => x.id == 'kubernetes-operator')[0].versions[0].version;
102+
addDynamicRoute("/server/kubernetes-operator", to => `/server/kubernetes-operator/${operatorLatest}/getting-started/`);
103+
addDynamicRoute("/server/kubernetes-operator/:version", to => `/server/kubernetes-operator/${to.params.version}/getting-started/`);
104+
102105
addDynamicRoute("/server/:version", to => `/server/${to.params.version}/quick-start/`);
103106
addDynamicRoute('/client/:lang',
104107
to => {

docs/.vuepress/components/breadCrumb.ts

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,20 +71,23 @@ export default defineComponent({
7171
if (notFound || meta.breadcrumbExclude) return null;
7272

7373
// Get the original title from metadata or name
74-
let title = meta.shortTitle || meta.title || name;
74+
let title = meta.shortTitle || meta.title;
75+
if (!title) {
76+
// Generate a title using the name
77+
title = name;
78+
// Remove dashes, remove file extensions, and capitalize first letter
79+
title = title.replace(/-/g, " ");
80+
title = title.replace(/\..*$/, "");
81+
title = title.trim();
82+
title = title.charAt(0).toUpperCase() + title.slice(1);
83+
}
7584

7685
// Check if the title should be replaced
7786
const replacement = breadcrumbReplacements[title.toLowerCase()];
7887
if (replacement) {
7988
title = replacement;
8089
}
8190

82-
// Remove dashes, remove file extensions, and capitalize first letter
83-
title = title.replace(/-/g, " ");
84-
title = title.replace(/\..*$/, "");
85-
title = title.trim();
86-
title = title.charAt(0).toUpperCase() + title.slice(1);
87-
8891
return {
8992
title,
9093
icon: meta.icon,

docs/.vuepress/configs/sidebar.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ export const sidebarEn: EsSidebarOptions = {
8181
],
8282
"/clients/grpc/": "structure",
8383
"/cloud/": "structure",
84-
"/server/kubernetes-operator/": "structure",
8584
...ver.getSidebars(),
8685
"/clients/tcp/dotnet/21.2/": "structure",
8786
};
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
title: KurrentDB Kubernetes Operator
2-
order: 1
31
---
4-
5-
# KurrentDB Kubernetes Operator
2+
# This directory exists to collect versions of the kubernetes operator docs,
3+
# but it should not appear as an extra breadcrumb layer.
4+
breadcrumbExclude: true
5+
---
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
# title is for breadcrumb and sidebar nav
3+
title: Kubernetes Operator v1.0.0
4+
order: 1
5+
---

docs/server/kubernetes-operator/getting-started/README.md renamed to docs/server/kubernetes-operator/v1.0.0/getting-started/README.md

File renamed without changes.

docs/server/kubernetes-operator/getting-started/images/install/deployments-list.png renamed to docs/server/kubernetes-operator/v1.0.0/getting-started/images/install/deployments-list.png

File renamed without changes.

docs/server/kubernetes-operator/getting-started/images/install/logs.png renamed to docs/server/kubernetes-operator/v1.0.0/getting-started/images/install/logs.png

File renamed without changes.

docs/server/kubernetes-operator/getting-started/images/install/namespace-list.png renamed to docs/server/kubernetes-operator/v1.0.0/getting-started/images/install/namespace-list.png

File renamed without changes.

0 commit comments

Comments
 (0)