Merge pull request #7 from singnet/senna-docs-2

Populates README with basic meta-info abput documents, repos etc
singnet · Mar 26, 2024 · cde385c · cde385c
2 parents ae25838 + 0700744
commit cde385c
Show file tree

Hide file tree

Showing 30 changed files with 34 additions and 231 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,34 @@
-# das
+# OpenCog Hyperon - Distributed Atomspace (DAS)
+
+Here, we keep stuff that is pertinent to the DAS project but doesn't belong to
+any of the other project's specific repositories, such as automated deployment
+scripts, API and high level documentation, assets used by other repositories'
+CI/CD scripts, etc.
+
+## Documentation
+
+* [DAS API](https://singnet.github.io/das-query-engine/api/das/) - Documentation of DAS API
+* _DAS User's Guide_
+* [DAS Overview](DAS-Overview.md) - Description of main DAS components and deployment architecture.
+* [DAS Toolbox User's Guide](https://github.com/singnet/das-toolbox) - A guide with detailed instructions to use the DAS Server Toolbox.
+
+## Repositories
+
+In addition to this one, we use many other repositories in the project.
+
+* [Query Engine](https://github.com/singnet/das-query-engine) - Source code for [hyperon-das](https://pypi.org/project/hyperon-das/), the Python library with the main [DAS API](https://singnet.github.io/das-query-engine/api/das/).
+* [Atom DB](https://github.com/singnet/das-atom-db) - Source code for [hyperon-das-atomdb](https://pypi.org/project/hyperon-das-atomdb/), a Python library required by hyperon-das to interface with DBMSs and other data storage structures.
+* [Serverless Functions](https://github.com/singnet/das-serverless-functions) and [OpenFaaS Templates](https://github.com/singnet/das-toolbox) - Source code of client/server communication components in DAS Server FaaS architecture.
+* [DAS MeTTa Parser](https://github.com/singnet/das-metta-parser) - A simplified MeTTa parser used to feed knowledge bases into DAS.
+* [DAS Server Toolbox](https://github.com/singnet/das-toolbox) - A set of tools to deploy and setup a DAS server.
+* Infrastructure setup - Tools and assets required to provision and setup servers in cloud providers.
+    * [Server provisioning in Vultr](https://github.com/singnet/das-pre-infra-vultr)
+    * [Server setup Vultr](https://github.com/singnet/das-infra-stack-vultr)
+    * [Server provisioning in AWS](https://github.com/singnet/das-pre-infra-aws)
+    * [Server setup AWS](https://github.com/singnet/das-infra-stack-aws)
+
+## Project management
+
+* [Public board](https://github.com/orgs/singnet/projects/7) - GitHub project board used to track bug reports, feature requests and major new features planning. Use this board to report bugs or request new features.
+* [Development board] (https://github.com/orgs/singnet/projects/6/views/1) - Used internally by the DAS Team to track issues and tasks.
+* _Contribution guidelines_
diff --git a/docs/Deployment-Process.md b/docs/Deployment-Process.md
diff --git a/docs/assets/components.jpg b/docs/assets/components.jpg
diff --git a/docs/assets/img14.jpg b/docs/assets/img14.jpg
diff --git a/docs/assets/img15.jpg b/docs/assets/img15.jpg
diff --git a/docs/assets/img18.jpg b/docs/assets/img18.jpg
diff --git a/docs/assets/img22.jpg b/docs/assets/img22.jpg
diff --git a/docs/assets/img29.jpg b/docs/assets/img29.jpg
diff --git a/docs/assets/img30.jpg b/docs/assets/img30.jpg
diff --git a/docs/assets/img33.jpg b/docs/assets/img33.jpg
diff --git a/docs/assets/img37.jpg b/docs/assets/img37.jpg
diff --git a/docs/assets/img43.jpg b/docs/assets/img43.jpg
diff --git a/docs/assets/img44.jpg b/docs/assets/img44.jpg
diff --git a/docs/assets/img47.jpg b/docs/assets/img47.jpg
diff --git a/docs/assets/img51.jpg b/docs/assets/img51.jpg
diff --git a/docs/assets/img52.jpg b/docs/assets/img52.jpg
diff --git a/docs/assets/img55.jpg b/docs/assets/img55.jpg
diff --git a/docs/assets/img61.jpg b/docs/assets/img61.jpg
diff --git a/docs/assets/img62.jpg b/docs/assets/img62.jpg
diff --git a/docs/assets/img65.jpg b/docs/assets/img65.jpg
diff --git a/docs/assets/img68.jpg b/docs/assets/img68.jpg
diff --git a/docs/assets/img72.jpg b/docs/assets/img72.jpg
diff --git a/docs/assets/img73.jpg b/docs/assets/img73.jpg
diff --git a/docs/assets/img77.jpg b/docs/assets/img77.jpg
diff --git a/docs/assets/img8.jpg b/docs/assets/img8.jpg
diff --git a/docs/assets/img81.jpg b/docs/assets/img81.jpg
diff --git a/docs/assets/img90.jpg b/docs/assets/img90.jpg
diff --git a/docs/assets/img91.jpg b/docs/assets/img91.jpg
diff --git a/docs/assets/img92.jpg b/docs/assets/img92.jpg
diff --git a/docs/assets/persistence_layer.jpg b/docs/assets/persistence_layer.jpg