summaryrefslogtreecommitdiffstats
path: root/Code-map.md
diff options
context:
space:
mode:
authorJon Bratseth <bratseth@verizonmedia.com>2019-02-13 15:02:05 +0100
committerJon Bratseth <bratseth@verizonmedia.com>2019-02-13 15:02:05 +0100
commit7097b927e3a54b38c57006a2525774f6816bb53d (patch)
treeb85806e8841021e4ffdb13b6ecebafb057a9be4f /Code-map.md
parent6cd73b95dcdcf95a07a726aab88147c2aa19a029 (diff)
WIP
Diffstat (limited to 'Code-map.md')
-rw-r--r--Code-map.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/Code-map.md b/Code-map.md
new file mode 100644
index 00000000000..7488b913fa6
--- /dev/null
+++ b/Code-map.md
@@ -0,0 +1,26 @@
+# A map to the Vespa code base
+
+You want to get familiar with the Vespa code base but don't know where to start?
+
+Vespa consists of about 1.7 million lines of code, about equal parts Java and C++.
+Since it it's mostly written by a team of developers selected for their ability
+to do this kind of thing unusually well, who have been given time to dedicate
+themselves to it for a long time, it is mostly easily to work with. However, one
+thing we haven't done is to create a module structure friendly to newcomers.
+
+This document aims to alleviate that somewhat by providing a map from the [[https://docs.vespa.ai/documentation/overview.html][functional elements]
+of Vespa to the top-level module structure
+[[https://github.com/vespa-engine/vespa][on Github]].
+
+We'll start with the query and write paths, outside in.
+
+## The stateless container
+
+When a request is made to Vespa it first enters some stateless container cluster.
+These containers consists of a core layer which provides general request-response
+handling (using Jetty for HTTP), component management, configuration and similar
+basic functionality.
+
+
+
+