Tutorial #0: Sparkour Conventions

by Brian Uri!, 2016-02-24


This tutorial describes the formatting conventions used in the Sparkour recipes. There is no hands-on work involved.

Tutorial Goals

  • You will understand how recipe instructions and code samples are presented.

Section Links


Sparkour recipes employ a few formatting conventions to make instructions clearer:

  • Page Name denotes the title of a page, or a tabbed pane within a page. This is also used to highlight important terminology.
  • Menu Item denotes an option in a menu that needs to be selected.
  • Button denotes an important button you need to press in a user interface (UI).
  • Field Name denotes the name of a form field in a UI or an XML element name.
  • Field Value denotes the value that you would enter into a form field or an XML element. Example values in a recipe generally include a sparkour- prefix. Feel free to customize this with a token relevant to your own work.
  • code word denotes technical coding concepts, such as the names of classes and variables, or the name of a Linux command line utility.

Code Samples

Commands to be typed at the Linux command line are bash-compatible and displayed in a syntax-highlighted box. The command prompt is not shown:

Code samples employ the Java, Python, R, or Scala programming languages. If the example has been translated into multiple languages, a separate box appears for each employed language. These boxes show code in Python by default, but you can change the language and use the 💾 icon to save your preferred language.

Code intended for the Spark interactive shells includes the shell prompt at the beginning of each line:

There is no interactive shell in Java.


You should now understand how the material in the remaining tutorials and recipes is presented. In the next tutorial, Tutorial #1: Apache Spark in a Nutshell, we learn more about Apache Spark.

Change Log

  • 2016-03-13: Added instructions for saving a preferred programming language (SPARKOUR-1).

Spot any inconsistencies or errors? See things that could be explained better or code that could be written more idiomatically? If so, please help me improve Sparkour by opening a ticket on the Issues page. You can also discuss this recipe with others in the Sparkour community on the Discussion page.

Apache, Spark, and Apache Spark are trademarks of the Apache Software Foundation (ASF).
Sparkour is © 2016 - 2022 by It is an independent project that is not endorsed or supported by Accenture Federal Services or the ASF.
visitors since February 2016