Skip to content

Commit 81ada0f

Browse files
committed
Update docs for 0.7.3 and upgrade deps
1 parent f14e221 commit 81ada0f

File tree

6 files changed

+956
-833
lines changed

6 files changed

+956
-833
lines changed

docs/16.building-from-source.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ Besides, the TLS/SSL components are written in C (OpenSSL) — so you'll nee
2020
Run this from your terminal:
2121

2222
```
23-
git clone --branch v0.7.2 https://github.com/skytable/skytable.git
23+
git clone --branch v0.7.3 https://github.com/skytable/skytable.git
2424
```
2525

2626
:::tip Bonus tip
2727
If you want to avoid downloading all the version history, run this instead:
2828

2929
```
30-
git clone --depth 1 --branch v0.7.2 https://github.com/skytable/skytable.git
30+
git clone --depth 1 --branch v0.7.3 https://github.com/skytable/skytable.git
3131
```
3232

3333
:::

docs/2.getting-started.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@ Getting started with Skytable is easy 😊 (and fun!). You can get started with
99

1010
### Step 1: Download a bundle
1111

12-
Head over to this [page](https://github.com/skytable/skytable/releases/v0.7.2) and download a version for your platform.
12+
Head over to this [page](https://github.com/skytable/skytable/releases/v0.7.3) and download a version for your platform.
13+
14+
:::tip Tip
15+
If you're on Debian, consider downloading an appropriate `.deb` (Debian Package) file for your machine.
16+
The package will install `skyd`, `skysh`, `sky-bench` and `sky-migrate` on your system while also
17+
configuring a `systemd` service unit.
18+
:::
1319

1420
### Step 2: Make the files runnable
1521

@@ -36,17 +42,18 @@ You may need superuser privileges for installation and running the commands belo
3642
### Step 0: Create and start the container
3743

3844
We'll create a container where:
45+
3946
1. We'll call our container `mysky`
4047
2. We'll expose port 2003 of the container
41-
3. We'll save all our data on the host in a folder in our `$HOME` directory. For this example, say the path to our home folder is `/home/sky`. To achieve this, we'll make use of Docker volumes.
48+
3. We'll save all our data on the host in a folder called `skytable` relative to the current directory. To achieve this, we'll make use of Docker volumes.
4249

4350
Open up a terminal and run:
4451

4552
```sh
4653
docker run --name mysky \
47-
-v /home/sky/skytable:/var/lib/skytable \
54+
-v ./skytable:/var/lib/skytable \
4855
-p 2003:2003 \
49-
skytable/sdb:v0.7.2
56+
skytable/sdb:v0.7.3
5057
```
5158

5259
### Step 1: Download and setup the bundle

docs/7.cfg-files.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ To use a configuration file:
5858
2. Start the database server with: `skyd -c /path/to/your/file.toml`
5959
3. Done 🎉
6060

61-
If you're confused about creating a configuration file, we always recommend you to download the template configuration from [this link](https://raw.githubusercontent.com/skytable/skytable/v0.7.2/examples/config-files/template.toml).
61+
If you're confused about creating a configuration file, we always recommend you to download the template configuration from [this link](https://raw.githubusercontent.com/skytable/skytable/v0.7.3/examples/config-files/template.toml).
6262

6363
That's all that's there to using configuration files!
6464

@@ -84,5 +84,5 @@ The official Docker image will look for a configuration file at `/etc/skytable/s
8484
```sh
8585
docker run --name skyd \
8686
-v /path/to/your/file.toml:/etc/skytable/skyd.toml \
87-
skytable/sdb:v0.7.2
87+
skytable/sdb:v0.7.3
8888
```

docs/7.cfg.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
id: config
3-
title: Configuration
4-
sidebar_label: Introduction
3+
title: Configuration basics
54
---
65

76
Skytable can be configured to a great degree, depending on your requirements. You can configure Skytable using:

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
"clear": "docusaurus clear"
1313
},
1414
"dependencies": {
15-
"@docusaurus/core": "^2.0.0-beta.14",
16-
"@docusaurus/preset-classic": "^2.0.0-beta.14",
17-
"@docusaurus/theme-search-algolia": "^2.0.0-beta.14",
15+
"@docusaurus/core": "^2.0.0-beta.15",
16+
"@docusaurus/preset-classic": "^2.0.0-beta.15",
17+
"@docusaurus/theme-search-algolia": "^2.0.0-beta.15",
1818
"@mdx-js/react": "^1.6.21",
1919
"clsx": "^1.1.1",
2020
"docusaurus-plugin-auto-sidebars": "^1.0.7",

0 commit comments

Comments
 (0)