Please use this markdown file as a template for writing your own Snowflake Quickstarts. This example guide has elements that you will use when writing your own quickstarts, including: code snippet highlighting, downloading files, inserting photos, and more.

It is important to include on the first page of your guide the following sections: Prerequisites, What you'll learn, What you'll need, and What you'll build. Remember, part of the purpose of a Snowflake Guide is that the reader will have built something by the end of the tutorial; this means that actual code needs to be included (not just pseudo-code or concepts).

The rest of this Snowflake Guide explains the steps of writing your own guide.

Prerequisites

What You'll Learn

What You'll Need

What You'll Build

It is important to set the correct metadata for your Snowflake Guide. The metadata contains all the information required for listing and publishing your guide and includes the following:

You can see the source metadata for this guide you are reading now, on the github repo.

A single sfguide consists of multiple steps. These steps are defined in Markdown using Header 2 tag ##.

## Step 1 Title
Duration: 3

All the content for the step goes here.

## Step 2 Title
Duration: 1

All the content for the step goes here.

To indicate how long each step will take, set the Duration under the step title (i.e. ##) to an integer. The integers refer to minutes. If you set Duration: 4 then a particular step will take 4 minutes to complete.

The total sfguide completion time is calculated automatically for you and will be displayed on the landing page.

Look at the markdown source for this sfguide to see how to use markdown to generate code snippets, info boxes, and download buttons.

JavaScript

{ 
  key1: "string", 
  key2: integer,
  key3: "string"
}

Java

for (statement 1; statement 2; statement 3) {
  // code block to be executed
}

Info Boxes

Buttons

Youtube - Halsey Playlists

Tables

**The table header**

The table body

with two columns

Hyperlinking

Youtube - Halsey Playlists

Look at the markdown source for this guide to see how to use markdown to generate these elements.

Images

Puppy

Videos

Videos from youtube can be directly embedded:

Inline Surveys

How do you rate yourself as a user of Snowflake?

Beginner Intermediate Advanced

Embed an iframe

This content has been imported from another markdown file. An imported document is called a fragment. Fragments are great when you have common information across multiple sfguides.

While you can embed things like images, videos, and surveys inside a fragment; you cannot define additional, top-level steps inside a fragment.

Videos

Inline Surveys

What is your favorite color?

Blue Green

The Conclusion and Next Steps section is one of the most important parts of a guide. This last section helps to sum up all the information the reader has gone through, and in many ways should read like a TLDR summary.

There are three main sub-headers in a Conclusion step:

  1. a general conclusion paragraph (what you are reading now!)
  2. "What We've Covered" section with a bulleted list of things
  3. "Related Resources" with links to various other resources, other guides, docs, videos, GitHub source code, etc.

It's also important to remember that by the time a reader has completed a Guide, the goal is that they have actually built something! Guides teach through hands-on examples – not just explaining concepts.

What We've Covered

Related Resources