Skip to content

Commit 1ad992f

Browse files
authored
meta: Fix links and update other meta (#121)
* meta: Bump versions * meta: re-enable search
1 parent 1c9b295 commit 1ad992f

File tree

3 files changed

+16
-14
lines changed

3 files changed

+16
-14
lines changed

docs/2.installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ However, we strongly recommend **not** using it outside testing environments.
2020

2121
To use native binaries you need to download a bundle which is simply a ZIP file with all the necessary binaries that you'll ever need to develop on and deploy Skytable.
2222

23-
1. **First download the latest bundle** for your platform. You can find [download links on the releases page](https://github.com/skytable/skytable/releases/v0.8.2).
23+
1. **First download the latest bundle** for your platform. You can find [download links on the releases page](https://github.com/skytable/skytable/releases/v0.8.3).
2424
2. **Unzip the ZIP file**. You'll find the following binaries in the extracted archive:
2525
- `skyd`: This is the database server binary which when started runs as a daemon, serving requests
2626
- `skysh`: This is the Skytable shell and it provides a very helpful interactive REPL database client
@@ -72,7 +72,7 @@ The package will:
7272
2. **Start the container**:
7373
7474
```shell
75-
docker run -d --name skydb -p 2003:2003 skytable/skytable:v0.8.2
75+
docker run -d --name skydb -p 2003:2003 skytable/skytable:v0.8.3
7676
```
7777
7878
:::tip
@@ -85,14 +85,14 @@ message with the generated password.
8585
1. **Download the bundle**: To be able to run queries you need to download the bundle as described above
8686
2. **Create the data directory**: To ensure that our database is persistent and all our data doesn't vanish as soon as the container is terminated, we'll map the data directory to an actual directory on our local system.
8787
> **Note:** Create a folder called `skytable` in a convenient location. We recommend having a directory in `$HOME/docker-containers` where you can store the Skytable container's data and any other containers that you might use. It's a great way to keep things organized.
88-
3. **Create your configuration**: [Download this template file](https://raw.githubusercontent.com/skytable/skytable/next/examples/config-files/template.yaml) and place it into the directory you created. Update the password with your `root` password of choice.
88+
3. **Create your configuration**: [Download this template file](https://raw.githubusercontent.com/skytable/skytable/v0.8.3/examples/config-files/template.yaml) and place it into the directory you created. Update the password with your `root` password of choice.
8989
4. **Start the container**:
9090

9191
```shell
9292
docker run -d --name skydb \
9393
-v $HOME/docker-containers/skytable:/var/lib/skytable \
9494
-p 2003:2003 \
95-
skytable/skytable:v0.8.2
95+
skytable/skytable:v0.8.3
9696
```
9797

9898
Explanation:

docs/protocol/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ We keep adding more and more data types with every release. So, if you're workin
1717
:::
1818

1919
Here are some good to know things, before a deep dive into the various pieces of the protocol:
20+
2021
- The protocol is based on top of TCP, so if your programming language standard library has a TCP client (as most of them do) you can build a client
2122
- You might find the [official implementation of the Rust client](https://github.com/skytable/client-rust) to be a good reference
2223
- If you need help, ask! (on Discord, ping us on Twitter, just reach out!)
@@ -25,8 +26,8 @@ Here are some good to know things, before a deep dive into the various pieces of
2526
## Protocol revisions and compatibility
2627

2728
- **What constitutes an incompatible protocol version?** A protocol version is considered incompatible if and only if:
28-
- the queries sent by an older client can't be processed by the server or
29-
- the **same** responses sent by *the server in question* can't be decoded by the older client
29+
- the queries sent by an older client can't be processed by the server or
30+
- the **same** responses sent by *the server in question* can't be decoded by the older client
3031
- If newer protocol versions introduce newer data types that is *not* considered an incompatible version since as long as the encoding for the types introduced in the earlier protocol(s) remains unchanged
3132
- Hence, the compatibility code for a protocol only changes when it is considered incompatible
3233

@@ -39,3 +40,4 @@ Please note this list is only maintained post 0.8.0.
3940
| 0.8.0 | 2.0-beta | `0` | Initial release of Skyhash/2 (beta) |
4041
| 0.8.1 | 2.0-beta | `0` | |
4142
| 0.8.2 | 2.0-beta | `0` | |
43+
| 0.8.3 | 2.0-beta | `0` | |

docusaurus.config.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ module.exports = {
1212
organizationName: "skytable",
1313
projectName: "docs",
1414
themeConfig: {
15-
// TODO(@ohsayan): see what's wrong with the search bar. indices are completely fine, must be something else in this config
16-
// algolia: {
17-
// appId: "BH4D9OD16A",
18-
// apiKey: "07040e0073a0b6b216f6619396984190",
19-
// indexName: "skytable",
20-
// searchParameters: {},
21-
// },
15+
algolia: {
16+
appId: "BH4D9OD16A",
17+
apiKey: "07040e0073a0b6b216f6619396984190",
18+
indexName: "skytable",
19+
searchParameters: {},
20+
contextualSearch: true,
21+
},
2222
sidebar: {
2323
hideable: true,
2424
},
@@ -125,7 +125,7 @@ module.exports = {
125125
lastVersion: 'current',
126126
versions: {
127127
current: {
128-
label: '0.8.2',
128+
label: '0.8.3',
129129
path: '/',
130130
}
131131
},

0 commit comments

Comments
 (0)