Inital commit

All branding was revised

Signed-off-by: Sayan Nandan <[email protected]>

Author: ohsayan

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+- package-ecosystem: cargo
+  directory: "/docbuilder"
+  schedule:
+    interval: daily
+    time: "11:00"
+  open-pull-requests-limit: 10
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "11:00"
+  open-pull-requests-limit: 10

.github/workflows/deploy-docs.yml

@@ -0,0 +1,28 @@
+name: Deploy docs
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v1
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+      - name: Install prerequisites
+        run: |
+          pip install mkdocs mkdocs-material mkdocs-git-revision-date-plugin
+      - name: Build docs
+        env:
+          BOT_USER: ${{ secrets.BOT_INIT_USER }}
+          BOT_MAIL: ${{ secrets.BOT_INIT_MAIL }}
+          BOT_API: ${{ secrets.BOT_API_CALL }}
+          GIT_SHA: ${{ env.GITHUB_SHA }}
+        run: |
+          chmod +x deploy.sh
+          sh deploy.sh

.gitignore

@@ -0,0 +1,3 @@
+**/site
+**/target
+**/docbuilder/actions.json*

LICENSE

@@ -0,0 +1,24 @@
+# Source for Skytable docs
+
+This repository contains the source code for the documentation hosted [here](https://docs.skytable.io).
+
+## Contributing
+
+The entire documentation website is available for everyone to improve (and reuse!). 
+
+If you want to improve an existing page, the best way to do it: is to click the pencil icon on a page that you want to edit. This will take you to the respective file where you can add what you want!
+
+### Steps
+
+1. Fork the repository
+2. Head over to the `docs` folder and change what you need to!
+3. Create a pull request [here](https://github.com/skytable/docs/pulls)
+4. One of the maintainers will respond almost immediately and suggest changes if required (usually they aren't needed - we know you're awesome 😉)
+5. Once your changes are approved - it will be merged 🎉
+6. Done! Thank you ❤️!
+
+**Note:** The documentation for the "Actions" are automatically generated from [this file](https://github.com/terrabasedb/terrabase/blob/next/actions.jsonc), so if you have any concern regarding the documentation of any action, update the aforementioned file. Thank you 😃
+
+## License
+
+The entire documentation is licensed under the [CC-BY-SA-4.0 License](./LICENSE).

README.md

@@ -0,0 +1 @@
+cd docbuilder && cargo run

builddoc.sh

@@ -0,0 +1,16 @@
+{
+    cd ..
+    git clone -b gh-pages https://github.com/skytable/docs.git ghp
+    cd -
+    mkdocs build
+    rm -rf ../ghp/*
+    mv site/* ../ghp/ -v
+    cd ../ghp
+    git checkout gh-pages
+    git config --global user.email "$BOT_MAIL"
+    git config --global user.name "$BOT_USER"
+    C_USER=$(git show -s --format='%an' HEAD)
+    C_MAIL=$(git show -s --format='%ae' HEAD)
+    git add . && git commit -m "Deployed ${GITHUB_SHA}"
+    eval '${BOT_API}'
+} >>/dev/null

deploy.sh

@@ -0,0 +1,10 @@
+[package]
+name = "docbuilder"
+version = "0.1.0"
+authors = ["Sayan Nandan <[email protected]>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+serde-hjson = "0.9.1"

docbuilder/Cargo.lock

@@ -0,0 +1,92 @@
+use serde_hjson::{self, Value};
+use std::cmp::Ordering;
+use std::io::prelude::*;
+use std::process;
+
+#[derive(Debug)]
+/// A structure to represent a (ACTION_NAME, ACTION_DOC_MD_FILE)
+///
+/// The second file (`.1`) contains the entire documentation file for a given
+/// action
+struct Document(String, String);
+
+impl PartialEq for Document {
+    fn eq(&self, other: &Self) -> bool {
+        self.0 == other.0
+    }
+}
+
+impl Eq for Document {}
+
+impl PartialOrd for Document {
+    fn partial_cmp(&self, other: &Document) -> std::option::Option<std::cmp::Ordering> {
+        self.0.partial_cmp(&other.0)
+    }
+}
+
+impl Ord for Document {
+    fn cmp(&self, other: &Self) -> Ordering {
+        self.0.cmp(&other.0)
+    }
+}
+
+fn main() {
+    let _dlfile = process::Command::new("wget")
+        .arg("https://raw.githubusercontent.com/terrabasedb/terrabasedb/next/actions.jsonc")
+        .output()
+        .unwrap();
+    let output = process::Command::new("cat")
+        .arg("actions.jsonc")
+        .output()
+        .unwrap();
+    let output = output.stdout;
+    let _rmfile = process::Command::new("rm")
+        .arg("actions.jsonc")
+        .output()
+        .unwrap();
+    let json: Value =
+        serde_hjson::from_str(&String::from_utf8_lossy(&output).to_owned().to_string()).unwrap();
+    let json = json.as_array().unwrap();
+    let mut actions = Vec::new();
+    for val in json {
+        let obj = val.as_object().unwrap();
+        let name = obj.get("name").unwrap().to_string();
+        let mut actionpage = String::new();
+        actionpage.push_str(&format!("# {}\n", name));
+        actionpage.push_str(&format!(
+            "<ins>**Since**</ins>: {}  \n",
+            obj.get("since").unwrap()
+        ));
+        actionpage.push_str(&format!(
+            "<ins>**Time complexity**</ins>: {}  \n",
+            obj.get("complexity").unwrap()
+        ));
+        actionpage.push_str(&format!(
+            "<ins>**Arguments**</ins>: `{}`  \n",
+            obj.get("args").unwrap()
+        ));
+        actionpage.push_str(&format!(
+            "<ins>**Returns**</ins>: {}  \n",
+            obj.get("return").unwrap()
+        ));
+        actionpage.push_str("\n");
+        actionpage.push_str(&obj.get("desc").unwrap().to_string());
+        actionpage.push('\n');
+        actions.push(Document(name, actionpage));
+    }
+    actions.sort();
+    create_docs(actions);
+}
+
+fn create_docs(list: Vec<Document>) {
+    let mut filetop = "# List Of Actions\n\n".to_owned();
+    filetop.push_str("Skytable currently supports the following actions: \n\n");
+    for action in list {
+        let name = action.0;
+        filetop.push_str(&format!("* [{}](Actions/{}.md)\n", &name, &name));
+        let mut file = std::fs::File::create(format!("../docs/Actions/{}.md", name)).unwrap();
+        file.write_all(&action.1.into_bytes()).unwrap();
+    }
+    let mut file = std::fs::File::create("../docs/Actions.md").unwrap();
+    file.write_all(filetop.as_bytes()).unwrap();
+}

docbuilder/Cargo.toml

@@ -0,0 +1,82 @@
+# Getting Started
+
+<html>
+<img src="/img/runner_start.svg" style="height: 300px; width: 100%; ">
+</html>
+<br>
+<br>
+
+Getting started with Skytable is easy 😊 (and fun!). You can get started with [native binaries (recommended)](#get-started-with-bundles) or by using the [docker image](#get-started-with-docker).
+
+## Get started with bundles
+
+### Step 1: Download a bundle
+
+Head over to the [releases page](https://github.com/terrabasedb/terrabase/releases) and download the latest version for your platform.
+
+### Step 2: Make the files runnable
+
+Unzip the `zip` file that you just downloaded. If you're on a *nix system, run `chmod +x sdb skysh` to make the files executable. If you're on Windows, right-click the files and then check the `UNBLOCK` checkbox and click on the `APPLY` button.
+
+### Step 3: Start the database server
+
+In the directory where you extracted the files, run `./sdb` on *nix systems or simply `sdb` on Windows systems. That's all there is to starting the database server!
+
+### Step 4: Run the shell `skysh`
+
+`skysh` is the shell that is shipped with the bundle. Run it, just like you did with the database server. Now enter commands in the shell, and have fun! First run `HEYA` to check if everything is fine - the server should reply with _HEY!_.
+See all the available actions [here](/List-Of-Actions)
+
+You're done with setting up `sdb` 🎉!
+
+## Get started with Docker
+
+First of all, you need to have Docker installed and available on your `PATH` ; you can read the official guide [here](https://docs.docker.com/get-docker/). Once you've got Docker up and running, follow the steps!
+
+### Step 0: Create a container
+
+Open up a terminal and run:
+
+``` 
+docker create skybasedb/sdb --name skyvm
+```
+
+> **NOTE:** You may need superuser priveleges
+
+At the same time, you'll need to set up the bundle by following [Step 1](#step-1-download-a-bundle) and [Step 2](#step-2-make-the-files-runnable) from the previous section.
+
+### Step 1: Start the container
+
+Now run:
+
+``` 
+docker start skyvm
+```
+
+> **NOTE:** You may need superuser priveleges
+
+### Step 2: Find the IP address of the container
+
+In order to connect to the container (which, to `skysh` is nothing but a remote server), you'll have to run:
+
+``` shell
+docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' skyvm
+```
+
+> **NOTE:** You may need superuser priveleges
+
+And you'll get a result like:
+
+``` text
+172.17.0.1
+```
+
+### Step 3: Start the command line client
+
+Open up a terminal in the directory where you downloaded the command line client and run:
+
+``` shell
+skysh -h 172.17.0.1
+```
+
+And you're done!