From 4c00b1cd549d9deeb29f08f506810464d723cd5a Mon Sep 17 00:00:00 2001 From: Matthew B White Date: Wed, 11 Dec 2024 10:27:04 +0000 Subject: [PATCH] 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 Co-authored-by: Bruno Volpato --- site/docs/tutorial/examples.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 site/docs/tutorial/examples.md diff --git a/site/docs/tutorial/examples.md b/site/docs/tutorial/examples.md new file mode 100644 index 000000000..9c6dc26d3 --- /dev/null +++ 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. + + +