Skip to content

Commit 61c38bf

Browse files
committed
Add docs for Java and NodeJS
1 parent 70f9252 commit 61c38bf

File tree

3 files changed

+44
-28
lines changed

3 files changed

+44
-28
lines changed

docs/.vuepress/client.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,28 @@ export default defineClientConfig({
118118
addDynamicRoute("/server/kubernetes-operator", to => `/server/kubernetes-operator/${operatorLatest}/getting-started/`);
119119
addDynamicRoute("/server/kubernetes-operator/:version", to => `/server/kubernetes-operator/${to.params.version}/getting-started/`);
120120

121+
// TODO: When we finish adding the docs for all clients, we can reduce these code
121122
const dotnetClient = __VERSIONS__.all.find(x => x.id === 'dotnet-client');
122123
const latestDotnetVersion = dotnetClient?.versions[0];
123124
addDynamicRoute('/clients/grpc/dotnet/:version', to => `/clients/grpc/dotnet/${to.params.version}/getting-started.html`);
124125
addDynamicRoute('/clients/grpc/dotnet/:version/', to => `/clients/grpc/dotnet/${to.params.version}/getting-started.html`);
125126
addDynamicRoute('/clients/grpc/dotnet', to => `/${dotnetClient?.basePath}/${latestDotnetVersion?.path}/${latestDotnetVersion?.startPage}`);
126127
addDynamicRoute('/clients/grpc/dotnet/', to => `/${dotnetClient?.basePath}/${latestDotnetVersion?.path}/${latestDotnetVersion?.startPage}`);
127128

129+
const nodeClient = __VERSIONS__.all.find(x => x.id === 'node-client');
130+
const latestNodeVersion = nodeClient?.versions[0];
131+
addDynamicRoute('/clients/grpc/node/:version', to => `/clients/grpc/node/${to.params.version}/getting-started.html`);
132+
addDynamicRoute('/clients/grpc/node/:version/', to => `/clients/grpc/node/${to.params.version}/getting-started.html`);
133+
addDynamicRoute('/clients/grpc/node', to => `/${nodeClient?.basePath}/${latestNodeVersion?.path}/${latestNodeVersion?.startPage}`);
134+
addDynamicRoute('/clients/grpc/node/', to => `/${nodeClient?.basePath}/${latestNodeVersion?.path}/${latestNodeVersion?.startPage}`);
135+
136+
const javaClient = __VERSIONS__.all.find(x => x.id === 'java-client');
137+
const latestJavaClient = javaClient?.versions[0];
138+
addDynamicRoute('/clients/grpc/java/:version', to => `/clients/grpc/java/${to.params.version}/getting-started.html`);
139+
addDynamicRoute('/clients/grpc/java/:version/', to => `/clients/grpc/java/${to.params.version}/getting-started.html`);
140+
addDynamicRoute('/clients/grpc/java', to => `/${javaClient?.basePath}/${latestJavaClient?.path}/${latestJavaClient?.startPage}`);
141+
addDynamicRoute('/clients/grpc/java/', to => `/${javaClient?.basePath}/${latestJavaClient?.path}/${latestJavaClient?.startPage}`);
142+
128143
addDynamicRoute("/server/:version", to => `/server/${to.params.version}/quick-start/`);
129144
addDynamicRoute('/client/:lang',
130145
to => {

docs/.vuepress/configs/navbar.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export const navbarEn: NavbarOptions = [
2929
children: [
3030
{ text: ".NET", link: ver.linksFor("dotnet-client", false)[0]?.link || "/clients/grpc/dotnet/" },
3131
{ text: "Python", link: "/clients/grpc/python/getting-started.html" },
32-
{ text: "Node.js", link: "/clients/grpc/nodejs/getting-started.html" },
33-
{ text: "Java", link: "/clients/grpc/java/getting-started.html" },
32+
{ text: "Node.js", link: ver.linksFor("node-client", false)[0]?.link || "/clients/grpc/node/" },
33+
{ text: "Java", link: ver.linksFor("java-client", false)[0]?.link || "/clients/grpc/java/" },
3434
{ text: "Go", link: "/clients/grpc/go/getting-started.html" },
3535
{ text: "Rust", link: "/clients/grpc/rust/getting-started.html" },
3636
],

import/repos.json

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -122,21 +122,22 @@
122122
{
123123
"id": "java-client",
124124
"group": "Java SDK",
125-
"basePath": "clients/java",
126-
"samplesRelativePath": [
127-
"src",
128-
"test",
129-
"java",
130-
"io",
131-
"kurrent",
132-
"dbclient",
133-
"samples"
134-
],
125+
"basePath": "clients/grpc/java",
126+
"docsRelativePath": [ "docs", "api" ],
127+
"samplesRelativePath": ["samples"],
128+
"currentBranch": "trunk",
135129
"repo": "https://github.com/kurrent-io/KurrentDB-Client-Java",
136130
"branches": [
137131
{
138-
"version": "5.4.5",
139-
"name": "trunk"
132+
"version": "v1.0",
133+
"name": "release/v1.0",
134+
"startPage": "getting-started.html"
135+
},
136+
{
137+
"version": "Legacy v5.4",
138+
"name": "release/legacy/v5.4",
139+
"deprecated": true,
140+
"startPage": "getting-started.html"
140141
}
141142
]
142143
},
@@ -155,24 +156,24 @@
155156
},
156157
{
157158
"id": "node-client",
158-
"group": "NodeJS SDK",
159-
"basePath": "clients/node",
160-
"samplesRelativePath": [
161-
"packages",
162-
"test",
163-
"src",
164-
"samples"
165-
],
159+
"group": "Node SDK",
160+
"basePath": "clients/grpc/node",
161+
"docsRelativePath": [ "docs", "api" ],
162+
"samplesRelativePath": ["samples"],
163+
"currentBranch": "master",
166164
"repo": "https://github.com/kurrent-io/KurrentDB-Client-NodeJS",
167165
"branches": [
168166
{
169-
"version": "6.2.1",
170-
"name": "master"
167+
"version": "v1.0",
168+
"name": "release/v1.0",
169+
"startPage": "getting-started.html"
170+
},
171+
{
172+
"version": "Legacy v6.2",
173+
"name": "release/legacy/v6.2",
174+
"deprecated": true,
175+
"startPage": "getting-started.html"
171176
}
172-
],
173-
"samplesPostprocess": [
174-
"pnpm babel <root> --presets @babel/preset-typescript --retain-lines --out-dir <root> --extensions .ts",
175-
"pnpm prettier --write <root>/*.js"
176177
]
177178
},
178179
{

0 commit comments

Comments
 (0)