Skip to content

Commit ab301a2

Browse files
Added versioned docs for balena-sdk nodejs
Change-type: patch Signed-off-by: Vipul Gupta (@vipulgupta2048) <[email protected]>
1 parent 1df6143 commit ab301a2

File tree

8 files changed

+45
-11
lines changed

8 files changed

+45
-11
lines changed

.cspell/balena-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ balena-builder
77
balenacli
88
balenahup
99
balenalib
10+
balenasdk
1011
balenista
1112
balenistas
1213
Barys

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ tmp
1414
.lycheecache
1515

1616
# Ignore external docs that are pulled via tools/fetch-external.sh
17-
pages/reference/sdk/node-sdk.md
17+
# pages/reference/sdk/node-sdk.md
1818
pages/reference/sdk/python-sdk.md
1919

2020
pages/reference/supervisor/supervisor-api.md
@@ -46,6 +46,10 @@ shared/masterclass
4646
config/dictionaries/balenacli.json
4747
shared/balena-cli-versions/
4848

49+
# Ignore dynamic balena-SDK version docs
50+
config/dictionaries/balenasdk.json
51+
shared/balena-sdk-versions/
52+
4953
# Ignore dynamic assets generated for Getting Started
5054
static/img/device/**
5155
config/dictionaries/device.json

config/navigation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Reference
151151

152152
CLI[/reference/balena-cli/$balenacli]
153153
SDKs
154-
Node.js SDK[/reference/sdk/node-sdk]
154+
Node.js SDK[/reference/sdk/node-sdk/$balenasdk]
155155
Python SDK[/reference/sdk/python-sdk]
156156
Deprecation Policy[/reference/sdk/deprecation-policy]
157157

config/redirects.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,8 @@
194194
/runtime/data-api /reference/api/overview/
195195
/tools/cli/ /reference/balena-cli/latest/
196196
/tools/cli /reference/balena-cli/latest/
197-
/tools/sdk/ /reference/sdk/node-sdk/
198-
/tools/sdk /reference/sdk/node-sdk/
197+
/tools/sdk/ /reference/sdk/node-sdk/latest/
198+
/tools/sdk /reference/sdk/node-sdk/latest/
199199
/tools/python-sdk/ /reference/sdk/python-sdk/
200200
/tools/python-sdk /reference/sdk/python-sdk/
201201
/runtime/resin-base-images/ /reference/base-images/balena-base-images/
@@ -270,6 +270,10 @@
270270
/reference/balena-cli/ /reference/balena-cli/latest/
271271
/reference/balena-cli /reference/balena-cli/latest/
272272

273+
# Versioned Node.js SDK docs
274+
/reference/sdk/node-sdk/ /reference/sdk/node-sdk/latest/
275+
/reference/sdk/node-sdk /reference/sdk/node-sdk/latest/
276+
273277
# Important: keep dynamic redirect below the static redirects
274278
# https://developers.cloudflare.com/pages/platform/redirects/
275279

pages/reference/sdk/node-sdk.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: balena Node.js SDK Documentation
3+
4+
layout: balena-sdk.html
5+
6+
dynamic:
7+
variables: [ $balenasdk ]
8+
ref: $original_ref/$balenasdk
9+
$switch_text: balena SDK version $balenasdk
10+
---
11+
12+
# Balena Node.js SDK {{ $balenasdk.version }} Documentation
13+
14+
{{import "balena-sdk-versions"}}

templates/balena-sdk.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{% extends "default.html" %}
2+
3+
{% block dynamicSwitchCustom %}
4+
<p class="dynamic-switch__append">
5+
</p>
6+
{% endblock %}
7+
8+
<div id="output"></div>

tools/build.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ node ./tools/generate-docs-contracts.js
1313
# Generate versioned balena-cli docs
1414
node ./tools/versioning.js https://github.com/balena-io/balena-cli/blob/master/docs/balena-cli.md
1515

16+
# Generate versioned balena-sdk docs
17+
node ./tools/versioning.js https://github.com/balena-io/balena-sdk/blob/master/DOCUMENTATION.md
18+
1619
# Generate Masterclasses Dynamically
1720
./tools/build-masterclass.sh
1821

tools/fetch-external.sh

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ cd shared/projects/ && {
8282
} &
8383

8484
# get latest node SDK docs
85-
cd pages/reference/sdk/ && {
86-
curl --fail --show-error -O -L https://github.com/balena-io/balena-sdk/raw/master/DOCUMENTATION.md
87-
echo "# Balena Node.js SDK" >node-sdk.md
88-
tail -n +2 DOCUMENTATION.md >>node-sdk.md
89-
rm DOCUMENTATION.md
90-
cd -
91-
} &
85+
# cd pages/reference/sdk/ && {
86+
# curl --fail --show-error -O -L https://github.com/balena-io/balena-sdk/raw/master/DOCUMENTATION.md
87+
# echo "# Balena Node.js SDK" >node-sdk.md
88+
# tail -n +2 DOCUMENTATION.md >>node-sdk.md
89+
# rm DOCUMENTATION.md
90+
# cd -
91+
# } &
9292

9393
# get SDK README
9494
cd shared/sdk/ && {

0 commit comments

Comments
 (0)