Initial version of the book

Jet-Engine · Jan 15, 2024 · 6061112 · 6061112
1 parent a10124d
commit 6061112
Show file tree

Hide file tree

Showing 11 changed files with 152 additions and 0 deletions.
diff --git a/book/.firebaserc b/book/.firebaserc
@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "callysto"
+  }
+}
diff --git a/book/.gitignore b/book/.gitignore
@@ -0,0 +1 @@
+.idea/
diff --git a/book/.nojekyll b/book/.nojekyll
diff --git a/book/_coverpage.md b/book/_coverpage.md
@@ -0,0 +1,5 @@
+# <img src="https://raw.githubusercontent.com/vertexclique/callysto/master/art/callysto_logo.png">
+RUST STREAM PROCESSING FRAMEWORK <small>1.0</small>
+
+[![](assets/img/github.svg) GitHub](https://github.com/vertexclique/callysto)
+[![](assets/img/sitemap-solid.svg) What is Callysto?](https://vertexclique.github.io/callysto/)
diff --git a/book/assets/img/github.svg b/book/assets/img/github.svg
diff --git a/book/assets/img/sitemap-solid.svg b/book/assets/img/sitemap-solid.svg
diff --git a/book/firebase.json b/book/firebase.json
@@ -0,0 +1,10 @@
+{
+  "hosting": {
+    "public": ".",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ]
+  }
+}
diff --git a/book/index.html b/book/index.html
@@ -0,0 +1,74 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover">
+  <meta name="description" content="">
+  <title></title>
+
+  <!-- Themes (light + dark) -->
+  <link rel="stylesheet" media="(prefers-color-scheme: dark)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
+
+  <!-- PrismJS theme -->
+  <link rel="stylesheet" href="https://unpkg.com/[email protected]/themes/prism-night-owl.min.css">
+
+  <!-- Custom Styles -->
+  <style>
+    :root {
+      --theme-hue: 120;
+      --theme-color: rgb(0, 85, 97);
+      /* <a href="https://ibb.co/mhM4z6P"><img src="https://i.ibb.co/DwSQK5j/vibrant-obelisk.png" alt="vibrant-obelisk" border="0"></a> */
+      --cover-background-color: #00000000;
+      --cover-background-image: url(https://i.postimg.cc/ZKsP4RfC/callysto-bg.png?dl=1);
+      --cover-button-background: rgb(0, 153, 174);
+      --cover-button-border: rgb(0, 153, 174);
+      --cover-button-border: 1px solid var(--theme-color);
+      --cover-heading-color: rgb(0, 85, 97);
+      --cover-heading-font-size: 100px;
+      --cover-heading-font-size-min: ;
+      --cover-heading-font-size-max: 500px;
+    }
+  </style>
+</head>
+<body>
+<div id="app"></div>
+
+<script>
+  // Docsify Configuration
+  window.$docsify = {
+    // GENERAL
+    // -----------------------------------------------------------------
+    name       : 'Callysto - Rust Stream Processing Framework',
+    repo: 'vertexclique/callysto',
+    coverpage  : 'coverpage.md',
+    homepage   : 'introduction.md',
+    loadSidebar: 'sidebar.md',
+
+    coverpage: true,
+    themeable: {
+      readyTransition : true, // default
+      responsiveTables: true  // default
+    }
+  };
+</script>
+
+<!-- Required -->
+<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/docsify-pagination.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/docsify-tabs.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/docsify-prism@latest/dist/docsify-prism.min.js"></script>
+
+<!-- CDN files for prism -->
+<script src="//unpkg.com/[email protected]/prism.js"></script>
+<script src="//unpkg.com/[email protected]/components/prism-rust.min.js"></script>
+<script src="//unpkg.com/[email protected]/components/prism-toml.min.js"></script>
+<script src="//unpkg.com/[email protected]/components/prism-python.min.js"></script>
+<script src="//unpkg.com/[email protected]/components/prism-json.min.js"></script>
+
+<!-- Recommended -->
+<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
+</body>
+</html>
diff --git a/book/introduction.md b/book/introduction.md
@@ -0,0 +1,11 @@
+# Callysto
+
+Callysto is a Rust framework for stream processing, which benefits from Rust’s concurrency model and optimized performance.
+It is made for writing distributed services at any scale, don't be tricked by the name of the framework, Callysto is basically for building services in a fault-tolerant way too.
+It contains necessary primitives to build self-healing services.
+
+Callysto made available with Kafka Streams mentality in Rust. It is for building high-performance distributed system and near real-time data pipelines to process large amounts of events.
+
+Callysto behaves like both stream processing and event processing framework, sharing similarity with tools such as Faust, Kafka Streams, Apache Spark/Storm/Samza/Flink.
+
+It is built on service oriented model to build microservices.
diff --git a/book/qguide.md b/book/qguide.md
@@ -0,0 +1,7 @@
+# Quickstart Guide
+
+To include callysto to your project
+
+```toml
+callysto = "0.1"
+```
diff --git a/book/sidebar.md b/book/sidebar.md
@@ -0,0 +1,37 @@
+<!-- markdownlint-disable-next-line first-line-heading -->
+- [Introduction](introduction)
+- [Quickstart Guide](qguide)
+- **Sources**
+- [Sources](sources)
+- **Flows**
+- [Flows](flows)
+- **Sinks**
+- [Sinks](sinks)
+- **Tables**
+- [Table Agents](tableagents)
+- **Persistence**
+- [RocksDB](rocksdb)
+- [In Memory](inmemory)
+- **Tasks**
+- [CronJobs](cronjobs)
+- [Timers](timers)
+- [Task](tasks)
+- **HTTP**
+- [Web Server](webserver)
+- [Pages](pages)
+- **Serde**
+- [Serializers](serializers)
+- [Deserializers](deserializers)
+- **Internals**
+- [Design Principles](designprinciples)
+- [Recovery System](recosystem)
+
+[//]: # (- **Links**)
+
+[//]: # (- [![Code]&#40;assets/img/code.svg&#41;Demo Sandbox]&#40;https://codesandbox.io/s/xv36w4695o&#41;)
+
+[//]: # (- [![Github]&#40;assets/img/github.svg&#41;Github]&#40;https://github.com/jhildenbiddle/docsify-themeable&#41;)
+
+[//]: # (- [![NPM]&#40;assets/img/npm.svg&#41;NPM]&#40;https://www.npmjs.com/package/docsify-themeable&#41;)
+
+[//]: # (- [![Twitter]&#40;assets/img/twitter.svg&#41;@jhildenbiddle]&#40;http://twitter.com/jhilde)