Skip to content

Commit

Permalink
meta: Fix links and update other meta (#121)
Browse files Browse the repository at this point in the history
* meta: Bump versions

* meta: re-enable search
  • Loading branch information
ohsayan authored Jun 15, 2024
1 parent 1c9b295 commit 1ad992f
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 14 deletions.
8 changes: 4 additions & 4 deletions docs/2.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ However, we strongly recommend **not** using it outside testing environments.

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.

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).
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).
2. **Unzip the ZIP file**. You'll find the following binaries in the extracted archive:
- `skyd`: This is the database server binary which when started runs as a daemon, serving requests
- `skysh`: This is the Skytable shell and it provides a very helpful interactive REPL database client
Expand Down Expand Up @@ -72,7 +72,7 @@ The package will:
2. **Start the container**:
```shell
docker run -d --name skydb -p 2003:2003 skytable/skytable:v0.8.2
docker run -d --name skydb -p 2003:2003 skytable/skytable:v0.8.3
```
:::tip
Expand All @@ -85,14 +85,14 @@ message with the generated password.
1. **Download the bundle**: To be able to run queries you need to download the bundle as described above
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.
> **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.
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.
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.
4. **Start the container**:

```shell
docker run -d --name skydb \
-v $HOME/docker-containers/skytable:/var/lib/skytable \
-p 2003:2003 \
skytable/skytable:v0.8.2
skytable/skytable:v0.8.3
```

Explanation:
Expand Down
6 changes: 4 additions & 2 deletions docs/protocol/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ We keep adding more and more data types with every release. So, if you're workin
:::

Here are some good to know things, before a deep dive into the various pieces of the protocol:

- 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
- You might find the [official implementation of the Rust client](https://github.com/skytable/client-rust) to be a good reference
- If you need help, ask! (on Discord, ping us on Twitter, just reach out!)
Expand All @@ -25,8 +26,8 @@ Here are some good to know things, before a deep dive into the various pieces of
## Protocol revisions and compatibility

- **What constitutes an incompatible protocol version?** A protocol version is considered incompatible if and only if:
- the queries sent by an older client can't be processed by the server or
- the **same** responses sent by *the server in question* can't be decoded by the older client
- the queries sent by an older client can't be processed by the server or
- the **same** responses sent by *the server in question* can't be decoded by the older client
- 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
- Hence, the compatibility code for a protocol only changes when it is considered incompatible

Expand All @@ -39,3 +40,4 @@ Please note this list is only maintained post 0.8.0.
| 0.8.0 | 2.0-beta | `0` | Initial release of Skyhash/2 (beta) |
| 0.8.1 | 2.0-beta | `0` | |
| 0.8.2 | 2.0-beta | `0` | |
| 0.8.3 | 2.0-beta | `0` | |
16 changes: 8 additions & 8 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ module.exports = {
organizationName: "skytable",
projectName: "docs",
themeConfig: {
// TODO(@ohsayan): see what's wrong with the search bar. indices are completely fine, must be something else in this config
// algolia: {
// appId: "BH4D9OD16A",
// apiKey: "07040e0073a0b6b216f6619396984190",
// indexName: "skytable",
// searchParameters: {},
// },
algolia: {
appId: "BH4D9OD16A",
apiKey: "07040e0073a0b6b216f6619396984190",
indexName: "skytable",
searchParameters: {},
contextualSearch: true,
},
sidebar: {
hideable: true,
},
Expand Down Expand Up @@ -125,7 +125,7 @@ module.exports = {
lastVersion: 'current',
versions: {
current: {
label: '0.8.2',
label: '0.8.3',
path: '/',
}
},
Expand Down

0 comments on commit 1ad992f

Please sign in to comment.