feat: add simple linking to the examples (#702)

Simple description of the examples and a link to the new one added in the substrait-java repo; this will need to wait until after that is merged to ensure no broken links., --------- Signed-off-by: MBWhite <[email protected]> Co-authored-by: Bruno Volpato <[email protected]>
substrait-io · Dec 11, 2024 · 4c00b1c · 4c00b1c
1 parent bd4b431
commit 4c00b1c
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/site/docs/tutorial/examples.md b/site/docs/tutorial/examples.md
@@ -0,0 +1,12 @@
+# Code samples and examples
+
+It's very useful to have examples of how APIs are used; both to get information on the best practices for using APIs and ideas of how they can be used. 
+
+Each language binding is intended to contain examples that are relevant to that language. New contributions are always welcome.
+
+## Java
+
+- [Substrait-Spark](https://github.com/substrait-io/substrait-java/tree/main/examples/substrait-spark) this demonstrates how Substrait plans can be created and consumed within Apache Spark. The examples run within a simple Spark cluster, composed by a couple of Docker containers.
+
+
+