Skip to content

Commit

Permalink
Update docs for 0.7.3 and upgrade deps
Browse files Browse the repository at this point in the history
  • Loading branch information
ohsayan committed Feb 14, 2022
1 parent f14e221 commit 81ada0f
Show file tree
Hide file tree
Showing 6 changed files with 956 additions and 833 deletions.
4 changes: 2 additions & 2 deletions docs/16.building-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ Besides, the TLS/SSL components are written in C (OpenSSL) — so you'll nee
Run this from your terminal:

```
git clone --branch v0.7.2 https://github.com/skytable/skytable.git
git clone --branch v0.7.3 https://github.com/skytable/skytable.git
```

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

```
git clone --depth 1 --branch v0.7.2 https://github.com/skytable/skytable.git
git clone --depth 1 --branch v0.7.3 https://github.com/skytable/skytable.git
```

:::
Expand Down
15 changes: 11 additions & 4 deletions docs/2.getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ Getting started with Skytable is easy 😊 (and fun!). You can get started with

### Step 1: Download a bundle

Head over to this [page](https://github.com/skytable/skytable/releases/v0.7.2) and download a version for your platform.
Head over to this [page](https://github.com/skytable/skytable/releases/v0.7.3) and download a version for your platform.

:::tip Tip
If you're on Debian, consider downloading an appropriate `.deb` (Debian Package) file for your machine.
The package will install `skyd`, `skysh`, `sky-bench` and `sky-migrate` on your system while also
configuring a `systemd` service unit.
:::

### Step 2: Make the files runnable

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

We'll create a container where:

1. We'll call our container `mysky`
2. We'll expose port 2003 of the container
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.
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.

Open up a terminal and run:

```sh
docker run --name mysky \
-v /home/sky/skytable:/var/lib/skytable \
-v ./skytable:/var/lib/skytable \
-p 2003:2003 \
skytable/sdb:v0.7.2
skytable/sdb:v0.7.3
```

### Step 1: Download and setup the bundle
Expand Down
4 changes: 2 additions & 2 deletions docs/7.cfg-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To use a configuration file:
2. Start the database server with: `skyd -c /path/to/your/file.toml`
3. Done 🎉

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).
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).

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

Expand All @@ -84,5 +84,5 @@ The official Docker image will look for a configuration file at `/etc/skytable/s
```sh
docker run --name skyd \
-v /path/to/your/file.toml:/etc/skytable/skyd.toml \
skytable/sdb:v0.7.2
skytable/sdb:v0.7.3
```
3 changes: 1 addition & 2 deletions docs/7.cfg.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
id: config
title: Configuration
sidebar_label: Introduction
title: Configuration basics
---

Skytable can be configured to a great degree, depending on your requirements. You can configure Skytable using:
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
"clear": "docusaurus clear"
},
"dependencies": {
"@docusaurus/core": "^2.0.0-beta.14",
"@docusaurus/preset-classic": "^2.0.0-beta.14",
"@docusaurus/theme-search-algolia": "^2.0.0-beta.14",
"@docusaurus/core": "^2.0.0-beta.15",
"@docusaurus/preset-classic": "^2.0.0-beta.15",
"@docusaurus/theme-search-algolia": "^2.0.0-beta.15",
"@mdx-js/react": "^1.6.21",
"clsx": "^1.1.1",
"docusaurus-plugin-auto-sidebars": "^1.0.7",
Expand Down
Loading

0 comments on commit 81ada0f

Please sign in to comment.