Gh-392: Add glossary section to documentation (#399)

* Creating new glossary page with initial terms and phrases that may be useful --------- Co-authored-by: GCHQDeveloper314 <[email protected]>
gchq · Sep 26, 2023 · c02e8ad · c02e8ad
1 parent 9bd58db
commit c02e8ad
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md
@@ -0,0 +1,22 @@
+---
+hide:
+  - toc
+---
+
+# Glossary
+
+| Term    | Description                          |
+| :---------- | :----------------------------------- |
+| Node        | A node is an entity within a graph  |
+| Edge        | An edge is a connection between two nodes |
+| Properties  | A property is a key/value pair that stores data on both edges and entities |
+| Python      | A programming language that is used to build applications. Gaffer uses python to interact with the API |
+| Java        | A object oriented programming language used to build software. Gaffer is primarily built in Java |
+| Database    | A database is a collection of organised structured information or data typically stored in a computer system |
+| API         | Application Programming Interface. An API is for one or more services / systems to communicate with each other |
+| JSON        | JavaScript Object Notation is a text based format for representing structure data based on JavaScript object syntax|
+| Element     | The word is used to describe the combination of both an edge and entity |
+| Entity      | An entity represents a point in a graph e.g. a person |
+| Stores      | A Gaffer store represents the backing database responsbile for storing or facilitating access to a graph |
+| Operations  | An operation is an instruction / function that you send to the API to manipulate and query a graph |
+| Vertex      | A vertex refers to the field in an entity that describes its type |