Add glossary (#859)

docs/mkdocs.yml

@@ -19,6 +19,10 @@ validation:
   unrecognized_links: warn
   anchors: warn
 
+# Preview controls
+watch:
+  - snippets
+
 # Theme configuration
 theme:
   name: material
@@ -68,6 +72,7 @@ plugins:
 
 # Extensions
 markdown_extensions:
+  - abbr
   - admonition
   - attr_list
   - md_in_html
@@ -80,7 +85,9 @@ markdown_extensions:
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.inlinehilite
-  - pymdownx.snippets
+  - pymdownx.snippets:
+      auto_append:
+        - snippets/abbreviations.md
   - pymdownx.superfences
   - pymdownx.tasklist:
       custom_checkbox: true

docs/snippets/abbreviations.md

@@ -0,0 +1,7 @@
+<!-- Glossary for terms and concepts not documented on cakeissues.net -->
+
+*[addins]: Addins allow to extend Cake language with additional aliases
+*[aliases]: Aliases are convenience methods that are easily accessible directly from a Cake build
+*[CI]: Continuous Integration - The practice of integrating source code changes frequently and ensuring that the integrated codebase is in a workable state
+*[linter]: A static code analysis tool used to flag programming errors, bugs, stylistic errors and suspicious constructs
+*[linters]: Static code analysis tools used to flag programming errors, bugs, stylistic errors and suspicious constructs