Generate latest docs on CI, from commit a66aa55.

.dockerignore

@@ -0,0 +1,150 @@
+.git
+**/.git
+
+# contents from .gitignore
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+# Specific files
+*.bc
+
+# Python
+__pycache__/
+*.pyc
+.ipynb_checkpoints
+*.egg-info/
+*.eggs
+python/*.eggs
+*.whl
+
+# coordinator
+coordinator/proto
+
+# python
+python/proto
+
+# Gar file
+*.gar
+
+# dot file
+*.dot
+
+# Protobuf GRPC
+*.pb.*
+*_pb2.py*
+*_pb2_grpc.py*
+
+# Visual Studio Code
+.vscode/
+.project
+.classpath
+.factorypath
+.settings
+
+# Mac OSX
+.DS_store
+
+# CLion
+.idea/
+cmake-build-*/
+**/*.iml
+**/target/
+
+# Workspace
+workspace/
+
+# etcd data directory
+default.etcd/
+
+# outer build directory
+build/
+analytical_engine/build/
+converter/build/
+vegito/build/
+
+# pom generated by maven-flatten-plugin
+**/.flattened-pom.xml
+
+# java sdk
+java/**/dependency-reduced-pom.xml
+
+# GraphLearn
+coordinator/graphlearn*
+
+# Lock files
+Chart.lock
+**/Cargo.lock
+package.lock
+
+# Core dump
+core.*
+*.core
+
+# cache
+.cache
+
+# GRIN header files
+interfaces/grin/include/
+interfaces/grin/build/
+
+# tmp directory
+tmp/
+
+apps/networkx/client/python/dist/
+apps/networkx/python_bindings/build/
+
+charts/gart/charts/
+
+k8s/debezium-config.yaml
+k8s/gart-config.yaml
+k8s/writer-deployment.yaml

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+-   repo: https://github.com/awslabs/git-secrets.git
+    rev: master
+    hooks:
+    -   id: git-secrets

_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css

@@ -0,0 +1,7 @@
+:root {
+--tabs-color-label-active: hsla(231, 99%, 66%, 1);
+--tabs-color-label-inactive: rgba(178, 206, 245, 0.62);
+--tabs-color-overline: rgb(207, 236, 238);
+--tabs-color-underline: rgb(207, 236, 238);
+--tabs-size-label: 1rem;
+}

_sources/docs.rst.txt

@@ -0,0 +1,126 @@
+.. GART documentation master file, created by
+   sphinx-quickstart on Tue Aug 27 10:19:05 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. meta::
+   :description: GART is a graph extension that includes an interface to an RDBMS and a dynamic graph store for online graph computation.
+   :keywords: distributed-systems, distributed, graph-analytics, in-memory-storage, big-data-analytics, distributed-comp
+
+GART: Graph Analysis on Relational Transactional Datasets
+=================================================================
+
+|Discussion| |License| |USENIX|
+
+GART Demo
+----------
+
+.. video:: https://github.com/user-attachments/assets/5044ea95-05fe-450a-9c70-395efb54fb43
+   :alt: GART Demo
+   :width: 640
+
+.. include:: documentation/getting-started/intro-content.rst
+
+Get started now!
+----------------
+
+.. panels::
+   :header: text-center
+   :column: col-lg-12 p-2
+
+   .. link-button:: documentation/getting-started/quick-start
+      :type: ref
+      :text: Getting Started
+      :classes: btn-block stretched-link
+   ^^^^^^^^^^^^
+   Get started with GART.
+
+   ---
+
+   .. link-button:: documentation/design/architecture
+      :type: ref
+      :text: Design
+      :classes: btn-block stretched-link
+   ^^^^^^^^^^^^
+   Learn about the architecture and key concepts of GART.
+
+   ---
+
+   .. link-button:: documentation/deployment/env-setup
+      :type: ref
+      :text: Deployment
+      :classes: btn-block stretched-link
+   ^^^^^^^^^^^^
+   Build environment and deploy GART.
+
+   ---
+
+   .. link-button:: documentation/tutorials/data-source-config
+      :type: ref
+      :text: Tutorials
+      :classes: btn-block stretched-link
+   ^^^^^^^^^^^^
+   Explore use cases and tutorials where GART can bring added value.
+
+   ---
+
+   .. link-button:: https://github.com/GraphScope/GART
+      :type: url
+      :text: Getting Involved
+      :classes: btn-block stretched-link
+   ^^^^^^^^^^^^
+   Get involved and become part of the GART community.
+
+Our Paper
+--------------
+
+- Sijie Shen, Zihang Yao, Lin Shi, Lei Wang, Longbin Lai, Qian Tao, Li Su, Rong Chen, Wenyuan Yu, Haibo Chen, Binyu Zang, Jingren Zhou.
+  `Bridging the Gap between Relational OLTP and Graph-based OLAP <https://www.usenix.org/system/files/atc23-shen.pdf>`_.
+  USENIX Annual Technical Conference, Boston, MA, USA, July 2023. |USENIX|.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Getting Started
+   :hidden:
+
+   documentation/getting-started/introduction
+   documentation/getting-started/quick-start
+   documentation/getting-started/use-cases
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Design
+   :hidden:
+
+   documentation/design/architecture
+   documentation/design/rgmapping
+   documentation/design/graph-storage
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Deployment
+   :hidden:
+
+   documentation/deployment/env-setup
+   documentation/deployment/deploy-distributed
+   documentation/deployment/deploy-k8s
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Tutorials
+   :hidden:
+
+   documentation/tutorials/data-source-config
+   documentation/tutorials/log-capturer-config
+   documentation/tutorials/rgmapping-config
+   documentation/tutorials/run-gap
+   documentation/tutorials/pgx
+
+.. |Discussion| image:: https://img.shields.io/badge/Discuss-Ask%20Questions-blue?logo=GitHub
+   :target: https://github.com/GraphScope/GART/issues
+
+.. |License| image:: https://img.shields.io/github/license/graphscope/gart
+   :target: https://github.com/GraphScope/GART/blob/main/LICENSE
+
+.. |USENIX| image:: https://img.shields.io/badge/USENIX-blue
+   :target: https://www.usenix.org/conference/atc23/presentation/shen

_sources/documentation/deployment/deploy-distributed.rst.txt

@@ -0,0 +1,69 @@
+.. _deploy-distributed:
+
+Distributed Deployment
+========================================
+
+GART is designed to be deployed in a distributed manner.
+This means that you can deploy different components of GART on different nodes of a cluster.
+To achieve this, you need to provide a configuration file, and GART provides a Python script to launch GART on a cluster easily.
+
+
+User Configuration
+--------------------
+Please ensure that the GART folder is accessible at the same path on all nodes of the cluster.
+Then you can create a configuration file in the following format:
+
+.. code:: json
+    :linenos:
+
+    {
+        // Database port
+        "db_host": "127.0.0.1",
+        // Database port
+        "db_port": 5432,
+        // Database type: mysql or postgresql
+        "db_type": "postgresql",
+        // Database name
+        "db_name": "ldbc",
+        // Database user
+        "db_user": "dbuser",
+        // Database password
+        "db_password": "123456",
+        "rgmapping_file": "/path/to/rgmapping.yaml",
+        "v6d_size": "750G",
+        "etcd_prefix": "gart_meta_",
+        // entrypoint of the kafka server
+        "kafka_server": "127.0.0.1:9092",
+        // total number of subgraphs
+        "total_subgraph_num": 2,
+        // path to the GART build folder
+        "gart_bin_path": "/path/to/GART/build/",
+        // whether to enable bulk load
+        "enable_bulkload": 1,
+        // where to launch the capturer
+        "capturer_host": "127.0.0.1",
+        // where to launch the converter
+        "converter_host": "127.0.0.1",
+        // path to kafka
+        "kafka_path": "/path/to/kafka",
+        "writer_hosts": [
+            {
+                // where to launch the writer to create subgraph 0
+                "subgraph_id": 0,
+                "host": "127.0.0.1"
+            },
+            {
+                // where to launch the writer to create subgraph 1
+                "subgraph_id": 1,
+                "host": "127.0.0.1"
+            }
+        ]
+    }
+
+Launch GART with configuration
+----------------------------------------
+GART provides a Python script to launch GART on a cluster easily. You can launch GART with the following command by providing the configuration file in the previous step:
+
+.. code:: bash
+
+    ./path/to/GART/scripts/distributed_deployment.py --config_file /path/to/user_config.json

_sources/documentation/deployment/deploy-k8s.rst.txt

@@ -0,0 +1,7 @@
+.. _deploy-k8s:
+
+Deployment on Kubernetes
+========================================
+
+GART also supports deployment on Kubernetes. The following steps will guide you through the process of deploying GART on Kubernetes.
+