v6d/docs/notes/key-concepts.rst at main · v6d-io/v6d · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
Key Concepts
============

.. toctree::
   :maxdepth: 1
   :caption: TOC
   :hidden:

   key-concepts/objects.rst
   key-concepts/vcdl.rst
   key-concepts/data-accessing.rst
   key-concepts/streams.rst
   key-concepts/io-drivers.rst

The *User Guide* section offers an in-depth understanding of vineyard's design
and implementation. It covers detailed environment setup instructions, the
architecture, and the core features within the vineyard engine.

*Additional information on vineyard's internals will be provided soon*.

.. tip::

   If you are new to vineyard, we recommend starting with the
   `Getting Started <https://v6d.io/notes/getting-started.html>`_ page for a smoother
   introduction.

Concepts
--------

.. panels::
   :header: text-center
   :column: col-lg-12 p-2

   .. link-button:: key-concepts/objects
      :type: ref
      :text: Vineyard Objects
      :classes: btn-block stretched-link
   ^^^^^^^^^^^^
   The design space of vineyard objects.

   ---

   .. link-button:: key-concepts/vcdl
      :type: ref
      :text: VCDL and Integration
      :classes: btn-block stretched-link
   ^^^^^^^^^^^^
   VCDL and how to integration vineyard with computing systems.

   ---

   .. link-button:: key-concepts/data-accessing
      :type: ref
      :text: Accessing Objects in Vineyard
      :classes: btn-block stretched-link
   ^^^^^^^^^^^^
   The approaches that can be used to access various kinds of objects stored in
   vineyard.

   ---

   .. link-button:: key-concepts/streams
      :type: ref
      :text: Stream in Vineyard
      :classes: btn-block stretched-link
   ^^^^^^^^^^^^
   The stream abstraction upon the immutable data sharing storage and its usages.

   ---

   .. link-button:: key-concepts/io-drivers
      :type: ref
      :text: I/O Drivers
      :classes: btn-block stretched-link
   ^^^^^^^^^^^^
   Design and implementation of the builtin I/O drivers that eases the integration
   of computing engines to existing infrastructure.