update docs (#102)

Author: tuhuynh27

core/src/main/java/dev/keva/core/server/KevaServer.java

@@ -41,7 +41,7 @@ public class KevaServer implements Server {
     private Channel channel;
 
     @Autowired
-    public KevaServer(KevaDatabase database, KevaConfig config, NettyChannelInitializer nettyChannelInitializer, CommandMapper commandMapper, AOFManager aofManager) {
+    private KevaServer(KevaDatabase database, KevaConfig config, NettyChannelInitializer nettyChannelInitializer, CommandMapper commandMapper, AOFManager aofManager) {
         this.database = database;
         this.config = config;
         this.nettyChannelInitializer = nettyChannelInitializer;

docs/package.json

@@ -15,5 +15,8 @@
   "license": "MIT",
   "devDependencies": {
     "vuepress": "^1.5.3"
+  },
+  "dependencies": {
+    "markdown-it-task-lists": "^2.1.1"
   }
 }

docs/src/.vuepress/config.js

@@ -98,5 +98,10 @@ module.exports = {
   plugins: [
     '@vuepress/plugin-back-to-top',
     '@vuepress/plugin-medium-zoom',
-  ]
+  ],
+  markdown: {
+    extendMarkdown: md => {
+      md.use(require('markdown-it-task-lists'))
+    }
+  }
 }

docs/src/.vuepress/styles/index.styl

@@ -8,7 +8,12 @@
   max-width 100px!important
 
 details
-  margin-bottom: 1rem
+  margin-bottom 1rem
 
 summary
-  cursor: pointer
+  cursor pointer
+
+ul.contains-task-list
+  padding-left 0!important
+.contains-task-list li
+  list-style-type none

docs/src/guide/developer-guide.md

@@ -41,6 +41,10 @@ Avoid using redundant keywords. To list a few:
 - `private` constructor modifier in an `enum`
 - field access prefixed with `this.` where unnecessary
 
+## Avoid using `lombok.val` and `lombok.var`
+
+Avoid using `lombok.val` and `lombok.var` in your code.
+
 ## Use `public` only when necessary
 
 The classes, methods and fields that are not meant to be used by a user should not be

docs/src/guide/overview/commands.md

@@ -2,7 +2,7 @@
 
 Follows [Redis's commands](https://redis.io/commands).
 
-Implemented commands:
+This is a list of commands that are available in the current latest version of Keva:
 
 <details>
     <summary>Server</summary>

docs/src/guide/roadmap.md

@@ -2,19 +2,22 @@
 
 ## Timeline
 
-- Start first development: Jan 2021
-- Keva RC release -> Dec 15 2021
-- Keva first Stable release -> Dec 30 2021
+- [x] Start first development: Jan 2021
+- [x] Keva alpha release: Dec 15 2021
+- [x] Keva RC release: Dec 30 2021
 
 ## Todo-list
 
-- Implement various Redis commands :heavy_check_mark:
-- Implement RDB, AOF persistence mode :heavy_check_mark:
-- Implement Pub/Sub :heavy_check_mark:
-- Implement Transactions :heavy_check_mark:
-- Implement Replication ([@axblueblader](https://github.com/axblueblader))
-- Implement Keva Proxy ([@haphananhtuan](https://github.com/haphananhtuan))
-- Implement Keva Sentinel ([@duongcongtoai](https://github.com/duongcongtoai))
-- Implement Keva SQL (TBD)
-- Implement Keva security
-- Create automation for release workflow
+- [ ] Create automation for release workflow
+- [x] Implement various [Redis commands](https://redis.io/commands)
+- [ ] Implement Redis commands: [STREAM](https://redis.io/commands/xread)
+- [x] Implement RDB, AOF persistence mode
+- [x] Implement Pub/Sub
+- [x] Implement Transactions
+- [ ] Implement [Lua scripting](https://redis.io/commands/eval)
+- [ ] Support `keva.conf` file for configuration
+- [ ] Implement Replication ([@axblueblader](https://github.com/axblueblader))
+- [ ] Implement Keva Proxy ([@haphananhtuan](https://github.com/haphananhtuan))
+- [ ] Implement Keva Sentinel ([@duongcongtoai](https://github.com/duongcongtoai))
+- [ ] Implement Keva SQL (TBD)
+- [ ] Implement Keva security

docs/yarn.lock

@@ -4931,6 +4931,11 @@ markdown-it-table-of-contents@^0.4.0:
   resolved "https://registry.yarnpkg.com/markdown-it-table-of-contents/-/markdown-it-table-of-contents-0.4.4.tgz#3dc7ce8b8fc17e5981c77cc398d1782319f37fbc"
   integrity sha512-TAIHTHPwa9+ltKvKPWulm/beozQU41Ab+FIefRaQV1NRnpzwcV9QOe6wXQS5WLivm5Q/nlo0rl6laGkMDZE7Gw==
 
+markdown-it-task-lists@^2.1.1:
+  version "2.1.1"
+  resolved "https://registry.yarnpkg.com/markdown-it-task-lists/-/markdown-it-task-lists-2.1.1.tgz#f68f4d2ac2bad5a2c373ba93081a1a6848417088"
+  integrity sha512-TxFAc76Jnhb2OUu+n3yz9RMu4CwGfaT788br6HhEDlvWfdeJcLUsxk1Hgw2yJio0OXsxv7pyIPmvECY7bMbluA==
+
 markdown-it@^8.4.1:
   version "8.4.2"
   resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-8.4.2.tgz#386f98998dc15a37722aa7722084f4020bdd9b54"