Fix JuliaEarth#185: Add glossary to docs

LakshyaKhatri · Sep 10, 2021 · 9322b71 · 9322b71
1 parent e259c0c
commit 9322b71
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/docs/make.jl b/docs/make.jl
@@ -74,7 +74,8 @@ makedocs(
     "Resources" => [
       "resources/education.md",
       "resources/publications.md",
-      "resources/ecosystem.md"
+      "resources/ecosystem.md",
+      "resources/glossary.md"
     ],
     "About" => [
       "Community" => "about/community.md",

diff --git a/docs/src/resources/glossary.md b/docs/src/resources/glossary.md
@@ -0,0 +1,13 @@
+# Glossary
+
+Below is a list of terms used consistently across the project.
+If you spot an inconsistency in a docstring, please report the
+issue or submit a pull request on GitHub.
+
+|   Term   | Description
+|:--------:|:------------|
+| `domain` | Geospatial domain implementing the `Meshes.Domain` trait |
+| `data`   | Geospatial data implementing the `Meshes.data` trait |
+| `var`    | Name of a variable as a `Symbol` inside of `data` |
+| `sdata`  | Source `data` where a geostatistical model is trained |
+| `tdata`  | Target `data` where a geostatistical model is applied |