Skip to content

Commit 01078ac

Browse files
committed
docs: update all version references from v1.0.0 to v1.1.0
Signed-off-by: AkarshSahlot <[email protected]>
1 parent d0ba293 commit 01078ac

File tree

2 files changed

+36
-36
lines changed

2 files changed

+36
-36
lines changed

docs/developer-guide/Kmeshctl-usage/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Pre-built binaries are available on our [releases page](https://github.com/kmesh
1111

1212
```bash
1313
# For AMD64 / x86_64
14-
[ $(uname -m) = x86_64 ] && curl -Lo ./kmeshctl https://github.com/kmesh-net/kmesh/releases/download/v1.0.0/kmeshctl-linux-amd64
14+
[ $(uname -m) = x86_64 ] && curl -Lo ./kmeshctl https://github.com/kmesh-net/kmesh/releases/download/v1.1.0/kmeshctl-linux-amd64
1515
# For ARM64
16-
[ $(uname -m) = aarch64 ] && curl -Lo ./kmeshctl https://github.com/kmesh-net/kmesh/releases/download/v1.0.0/kmeshctl-linux-arm64
16+
[ $(uname -m) = aarch64 ] && curl -Lo ./kmeshctl https://github.com/kmesh-net/kmesh/releases/download/v1.1.0/kmeshctl-linux-arm64
1717
chmod +x ./kmeshctl
1818
sudo mv ./kmeshctl /usr/local/bin/kmeshctl
1919
```

docs/developer-guide/website/versioning-doc.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Docusaurus offers robust built-in support for versioning documentation, a critic
1414
Docusaurus provides a straightforward system for versioning documentation:
1515

1616
- **Current Version**: This is the latest, actively maintained version of your documentation, stored in the `docs/` folder. It typically represents the "Next" version or the most recent unreleased changes.
17-
- **Versioned Docs**: These are snapshots of your documentation at specific points in time, usually tied to software releases. They are stored in folders named `versioned_docs/version-<version>/`, such as `versioned_docs/version-1.0/` for version 1.0.
17+
- **Versioned Docs**: These are snapshots of your documentation at specific points in time, usually tied to software releases. They are stored in folders named `versioned_docs/version-<version>/`, such as `versioned_docs/version-1.1.0/` for version 1.1.0.
1818

1919
For example:
2020

@@ -23,10 +23,10 @@ For example:
2323
my-docusaurus-project/
2424
├── docs/ # Current version documentation
2525
├── versioned_docs/ # All versioned documentation
26-
│ ├── version-1.0/ # Version 1.0 documentation
26+
│ ├── version-1.1.0/ # Version 1.1.0 documentation
2727
│ └── version-1.1/ # Version 1.1 documentation
2828
├── versioned_sidebars/ # Sidebars for each version
29-
│ ├── version-1.0-sidebars.json
29+
│ ├── version-1.1.0-sidebars.json
3030
│ └── version-1.1-sidebars.json
3131
└── versions.json # List of all available versions
3232
```
@@ -57,24 +57,24 @@ or
5757
yarn docusaurus docs:version <version>
5858
```
5959

60-
Replace `<version>` with your desired version number, e.g., `1.0`.
60+
Replace `<version>` with your desired version number, e.g., `1.1.0`.
6161

6262
- **What Happens**:
63-
- Docusaurus duplicates the entire `docs/` folder into `versioned_docs/version-1.0/`.
63+
- Docusaurus duplicates the entire `docs/` folder into `versioned_docs/version-1.1.0/`.
6464
- It updates the `versions.json` file, which tracks all versioned documentation.
6565

66-
Example `versions.json` after creating version 1.0:
66+
Example `versions.json` after creating version 1.1.0:
6767

6868
```json
6969
// File: versions.json
7070
[
71-
"1.0"
71+
"1.1.0"
7272
]
7373
```
7474

7575
### Step 2: Customize Version Labels
7676

77-
By default, the version number (e.g., "1.0") appears in the sidebar and version selector. You can customize these labels in `docusaurus.config.js`:
77+
By default, the version number (e.g., "1.1.0") appears in the sidebar and version selector. You can customize these labels in `docusaurus.config.js`:
7878

7979
```javascript
8080
// File: docusaurus.config.js
@@ -85,7 +85,7 @@ module.exports = {
8585
docs: {
8686
sidebar: {
8787
versionLabels: {
88-
'1.0': 'Version 1.0 (Legacy)',
88+
'1.1.0': 'Version 1.1.0 (Legacy)',
8989
'1.1': 'Version 1.1',
9090
'current': 'Next (Unreleased)'
9191
},
@@ -125,7 +125,7 @@ This creates a new snapshot in `versioned_docs/version-2.0/` and updates `versio
125125
// File: versions.json (after adding version 2.0)
126126
[
127127
"2.0",
128-
"1.0"
128+
"1.1.0"
129129
]
130130
```
131131

@@ -136,16 +136,16 @@ To delete a version:
136136
```bash
137137
# File: terminal command
138138
# 1. Remove the version folder
139-
rm -rf versioned_docs/version-1.0
140-
rm -rf versioned_sidebars/version-1.0-sidebars.json
139+
rm -rf versioned_docs/version-1.1.0
140+
rm -rf versioned_sidebars/version-1.1.0-sidebars.json
141141

142142
# 2. Update versions.json manually
143143
```
144144

145145
Edit `versions.json` to remove the version:
146146

147147
```json
148-
// File: versions.json (after removing version 1.0)
148+
// File: versions.json (after removing version 1.1.0)
149149
[
150150
"2.0"
151151
]
@@ -164,18 +164,18 @@ When you create a version, Docusaurus automatically creates a sidebar configurat
164164
```json
165165
// File: versioned_sidebars/version-1.0-sidebars.json (automatically generated)
166166
{
167-
"version-1.0/docs": [
167+
"version-1.1.0/docs": [
168168
{
169169
"type": "category",
170170
"label": "Getting Started",
171171
"items": [
172172
{
173173
"type": "doc",
174-
"id": "version-1.0/intro"
174+
"id": "version-1.1.0/intro"
175175
},
176176
{
177177
"type": "doc",
178-
"id": "version-1.0/installation"
178+
"id": "version-1.1.0/installation"
179179
}
180180
]
181181
}
@@ -188,20 +188,20 @@ When you create a version, Docusaurus automatically creates a sidebar configurat
188188
For more control, you can modify the versioned sidebar file directly:
189189

190190
```javascript
191-
// File: versioned_sidebars/version-1.0-sidebars.json (customized)
191+
// File: versioned_sidebars/version-1.1.0-sidebars.json (customized)
192192
{
193-
"version-1.0/docs": [
193+
"version-1.1.0/docs": [
194194
{
195195
"type": "category",
196196
"label": "Getting Started",
197197
"items": [
198198
{
199199
"type": "doc",
200-
"id": "version-1.0/intro"
200+
"id": "version-1.1.0/intro"
201201
},
202202
{
203203
"type": "doc",
204-
"id": "version-1.0/installation"
204+
"id": "version-1.1.0/installation"
205205
}
206206
]
207207
},
@@ -211,7 +211,7 @@ For more control, you can modify the versioned sidebar file directly:
211211
"items": [
212212
{
213213
"type": "doc",
214-
"id": "version-1.0/advanced/configuration"
214+
"id": "version-1.1.0/advanced/configuration"
215215
}
216216
]
217217
}
@@ -249,7 +249,7 @@ In your documentation, you can link to specific versions:
249249
```markdown
250250
<!-- File: docs/my-doc.md -->
251251

252-
Check our [installation guide for v1.0](/docs/1.0/installation) or the [latest installation guide](/docs/installation).
252+
Check our [installation guide for v1.1.0](/docs/1.1.0/installation) or the [latest installation guide](/docs/installation).
253253
```
254254

255255
---
@@ -288,9 +288,9 @@ Check our [installation guide for v1.0](/docs/1.0/installation) or the [latest i
288288
label: '2.0',
289289
path: '2.0',
290290
},
291-
'1.0': {
292-
label: '1.0 (Legacy)',
293-
path: '1.0',
291+
'1.1.0': {
292+
label: '1.1.0 (Legacy)',
293+
path: '1.1.0',
294294
banner: 'unmaintained', // Adds a banner indicating this version is no longer maintained
295295
},
296296
},
@@ -305,25 +305,25 @@ Check our [installation guide for v1.0](/docs/1.0/installation) or the [latest i
305305

306306
## 7. Example Scenario
307307

308-
Let's walk through versioning for a software project with two releases: 1.0 and 2.0.
308+
Let's walk through versioning for a software project with two releases: 1.1.0 and 2.0.
309309

310310
```bash
311311
# File: terminal commands for versioning workflow
312-
# Initial setup - create version 1.0
313-
npm run docusaurus docs:version 1.0
312+
# Initial setup - create version 1.1.0
313+
npm run docusaurus docs:version 1.1.0
314314

315315
# Result:
316-
# - versioned_docs/version-1.0/ contains a snapshot of docs/
317-
# - versioned_sidebars/version-1.0-sidebars.json is created
318-
# - versions.json now includes "1.0"
316+
# - versioned_docs/version-1.1.0/ contains a snapshot of docs/
317+
# - versioned_sidebars/version-1.1.0-sidebars.json is created
318+
# - versions.json now includes "1.1.0"
319319

320320
# Later - update docs/ with changes for version 2.0 and create version 2.0
321321
npm run docusaurus docs:version 2.0
322322

323323
# Result:
324324
# - versioned_docs/version-2.0/ is created
325325
# - versioned_sidebars/version-2.0-sidebars.json is created
326-
# - versions.json now includes "2.0" and "1.0"
326+
# - versions.json now includes "2.0" and "1.1.0"
327327
# - docs/ becomes the "Next" version
328328
```
329329

@@ -335,7 +335,7 @@ my-docusaurus-project/
335335
├── docs/ # Current "Next" version
336336
├── versioned_docs/
337337
│ ├── version-2.0/ # Version 2.0 documentation
338-
│ └── version-1.0/ # Version 1.0 documentation
338+
│ └── version-1.1.0/ # Version 1.1.0 documentation
339339
├── versioned_sidebars/
340340
│ ├── version-2.0-sidebars.json
341341
│ └── version-1.0-sidebars.json
@@ -346,7 +346,7 @@ The result is a site where users can easily navigate between versions through th
346346

347347
- **Next**: Latest unreleased changes
348348
- **2.0**: Documentation for version 2.0
349-
- **1.0 (Legacy)**: Documentation for version 1.0
349+
- **1.1.0 (Legacy)**: Documentation for version 1.0
350350

351351
---
352352

0 commit comments

Comments
 (0)