This is the source code used for the tutorial available at http://saucelabs.com/java.
The basis of the tutorial is a series of markdown files. These can be edited, but special care must be taken because some unconventional symbols/expressions are used to create special behavior when the files are rendered on Sauce's website.
Images are in img/
Tutorial pages can be linked to each other by wrapping a URL with ##, as
in the following example:
[Link to intro page](##00-Introduction.md##)
The link will be processed to point to the correct place in the Sauce website.
The same convention can be used for images. It is assumed they are in the img
directory so that prefix is not necessary:
(This will display the image located at img/my_cool_image.png).
Blocks of text which should only show up for specific platforms should be wrapped like so:
<!-- SAUCE:BEGIN_PLATFORM:MAC|LINUX -->
.... some mac/linux only text here ....
<!-- SAUCE:END_PLATFORM -->
Platform names can be MAC, LINUX, or WIN, and can be unioned by using the
pipe symbol.
You can insert the Sauce username or access key like so:
vendor\bin\sauce_config.bat <!-- SAUCE:USERNAME --> <!-- SAUCE:ACCESS_KEY -->
Which will show up as <username> and <access_key> if the user is not logged in.
If the user is not logged in, you can generate an inline signup form with:
<!-- SAUCE:LOGIN -->
It's possible to reuse markdown code in multiple tutorial files. For example,
if I have a file in include/reuse-me.md, I can have it generated in
a tutorial markdown file like so:
... some text ...
<!-- SAUCE:INCLUDE:reuse-me -->
... more text ...
When the file is rendered on Sauce's website, the contents of
include/reuse-me.md will be inserted (before any other processing) in that
location. Note that "include/" and ".md" are part of the convention and are
assumed.
If you find errors in the tutorials or ways that they can be improved, please fork and send a pull request. We'd love your help in making these the best instructions ever on how to get started with Selenium WebDriver, Java, and Sauce Labs!