From f1f5438a3dc80e2fbe531d062a23aa8b21948411 Mon Sep 17 00:00:00 2001
From: Grigory Statsenko <gstatsenko@nebius.com>
Date: Thu, 16 Nov 2023 14:02:23 +0100
Subject: [PATCH] Knowledge Base Begins

---
 .gitignore                  |  1 +
 README.md                   | 41 +++++++----------------------------
 kb/index.md                 |  6 ++++++
 kb/tooling/index.md         |  7 ++++++
 kb/tooling/task_commands.md | 43 +++++++++++++++++++++++++++++++++++++
 5 files changed, 65 insertions(+), 33 deletions(-)
 create mode 100644 kb/index.md
 create mode 100644 kb/tooling/index.md
 create mode 100644 kb/tooling/task_commands.md

diff --git a/.gitignore b/.gitignore
index 1ab2f3221..43c6d713b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,3 +15,4 @@ ci_artifacts
 .DS_Store
 artifacts
 Taskfile.yml
+.obsidian
diff --git a/README.md b/README.md
index 966a18acd..f001b2204 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,15 @@
-## Management tasks
+# datalens-backend
 
-Running tasks:
-```
-task <task_name>
-```
+## About
 
+This is the repository for the back-end implementation of DataLens
 
-### Environment (`env:`)
+Head over to the [Knowledge Base](kb/index.md) for documentation on this repo.
 
-- `task env:devenv`:
-  Create development/testing environment (run it from a package dir)
-- `task env:devenv-d`:
-  Create development/testing environment in detached mode (run it from a package dir)
-- `task env:ensure_venv`: Command to create virtual env for the mainrepo tools. 
-  It requires presence of .env in the mainrepo/tools.
+[Code of conduct](CODE_OF_CONDUCT.md)
 
+[Contributing](CONTRIBUTING.md)
 
-### Generation (`gen:`)
+## License
 
-- `task gen:antlr`:
-  (Re-)generate ANTLR code files for formula
-- `task gen:i18n-po`:
-  Sync/generate `.po` files for package (run it from a package dir)
-- `task gen:i18n-binaries`:
-  Generate binary `.mo` files from `.po` files for package (run it from a package dir)
-
-
-### Code quality (`cq:`)
-
-Experimental tasks to check and fix source files. 
- 
-- `task cq:fix_changed`:
-  Apply all auto-fixes
-- `task cq:check_changed`:
-  Check for any non-conformity in code style/format/lint
-- `task cq:fix_dir -- {single dir}`:
-  Apply all auto-fixes to the given dir absolute path
-- `task cq:check_dir -- {single dir}`:
-  Check for any non-conformity in code style/format/lint in the given dir abs path
+`datalens-backend` is available under the Apache 2.0 license.
diff --git a/kb/index.md b/kb/index.md
new file mode 100644
index 000000000..4d64a2fb6
--- /dev/null
+++ b/kb/index.md
@@ -0,0 +1,6 @@
+# Datalens Backend Knowledge Base
+
+Welcome to the KB!
+
+See:
+- [Repository tooling](tooling/index.md)
diff --git a/kb/tooling/index.md b/kb/tooling/index.md
new file mode 100644
index 000000000..5c5870602
--- /dev/null
+++ b/kb/tooling/index.md
@@ -0,0 +1,7 @@
+# Repository Tooling
+
+This section is about the custom tooling available in this repo.
+
+- [task commands](task_commands.md) - a set of (`make`-like) shortcuts for various commands and scripts for repository management, development, testing, etc.
+- [dl-git](../../terrarium/dl_gitmanager/README.md) - a wrapper for advanced git commands, for usage mainly in the CI workflow
+- [dl-repo / dl-package](../../terrarium/dl_repmanager/README.md) - tools for managing and inspecting packages, their dependencies, meta-packages, etc.
diff --git a/kb/tooling/task_commands.md b/kb/tooling/task_commands.md
new file mode 100644
index 000000000..7c65a2936
--- /dev/null
+++ b/kb/tooling/task_commands.md
@@ -0,0 +1,43 @@
+## Management tasks
+
+These commands require the ``taskfile`` tool. See [this page](https://taskfile.dev/installation/)
+for installation options.
+
+Running tasks:
+```
+task <task_name>
+```
+
+
+### Environment (`env:`)
+
+- `task env:devenv`:
+  Create development/testing environment (run it from a package dir)
+- `task env:devenv-d`:
+  Create development/testing environment in detached mode (run it from a package dir)
+- `task env:ensure_venv`: Command to create virtual env for the mainrepo tools. 
+  It requires presence of .env in the mainrepo/tools.
+
+
+### Generation (`gen:`)
+
+- `task gen:antlr`:
+  (Re-)generate ANTLR code files for formula
+- `task gen:i18n-po`:
+  Sync/generate `.po` files for package (run it from a package dir)
+- `task gen:i18n-binaries`:
+  Generate binary `.mo` files from `.po` files for package (run it from a package dir)
+
+
+### Code quality (`cq:`)
+
+Experimental tasks to check and fix source files. 
+ 
+- `task cq:fix_changed`:
+  Apply all auto-fixes
+- `task cq:check_changed`:
+  Check for any non-conformity in code style/format/lint
+- `task cq:fix_dir -- {single dir}`:
+  Apply all auto-fixes to the given dir absolute path
+- `task cq:check_dir -- {single dir}`:
+  Check for any non-conformity in code style/format/lint in the given dir abs path