hello

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

Prerequisites

• Familiarity with Markdown syntax

What You'll Learn

• how to set the metadata for a guide (category, author, id, etc)
• how to set the amount of time each slide will take to finish
• how to include code snippets
• how to hyperlink items
• how to include images

What You'll Need

• A GitHub Account
• VSCode Installed
• NodeJS Installed
• GoLang Installed

What You'll Build

• A Snowflake Guide

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:

• summary: This is a sample Snowflake Guide
  • This should be a short, 1 sentence description of your guide. This will be visible on the main landing page.
• id: sample
  • make sure to match the id here with the name of the file, all one word.
• categories: data-science
  • You can have multiple categories, but the first one listed is used for the icon.
• environments: web
  • web is default. If this will be published for a specific event or conference, include it here.
• status: Published
  • (Draft, Published, Deprecated, Hidden) to indicate the progress and whether the sfguide is ready to be published. Hidden implies the sfguide is for restricted use, should be available only by direct URL, and should not appear on the main landing page.
• feedback link: https://github.com/Snowflake-Labs/sfguides/issues
• tags: Getting Started, Data Science, Twitter
  • Add relevant tags to make your sfguide easily found and SEO friendly.
• authors: Daniel Myers
  • Indicate the author(s) of this specific sfguide.

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

This is a download button

Tables

Hyperlinking

Youtube - Halsey Playlists

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

Images

Videos

Videos from youtube can be directly embedded:

Inline Surveys

Embed an iframe

At the end of your Snowflake Guide, always have a clear call to action (CTA). This CTA could be a link to the docs pages, links to videos on youtube, a GitHub repo link, etc.

If you want to learn more about Snowflake Guide formatting, checkout the official documentation here: Formatting Guide

What You Learned

• creating steps and setting duration
• adding code snippets
• embedding images, videos, and surveys
• importing other markdown files

Related Resources