summary: This is a sample Snowflake Guide id: sample categories: undefined environments: web status: Hidden feedback link: https://github.com/Snowflake-Labs/sfguides/issues tags: Getting Started, Data Science, Data Engineering, Twitter authors: Snowflake
Duration: 1
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.
- Familiarity with Markdown syntax
- 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
- A Snowflake Guide
Duration: 2
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.
Duration: 2
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.
Duration: 2
Look at the markdown source for this sfguide to see how to use markdown to generate code snippets, info boxes, and download buttons.
{
key1: "string",
key2: integer,
key3: "string"
}
for (statement 1; statement 2; statement 3) {
// code block to be executed
}
aside positive
This will appear in a positive info box.
aside negative
This will appear in a negative info box.
**The table header** | |
---|---|
The table body | with two columns |
Duration: 2
Look at the markdown source for this guide to see how to use markdown to generate these elements.
Videos from youtube can be directly embedded:
How do you rate yourself as a user of Snowflake?Duration: 1 <<_imports/sample_import.md>>
Duration: 1
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:
- a general conclusion paragraph (what you are reading now!)
- "What We've Covered" section with a bulleted list of things
- "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.
- creating steps and setting duration
- adding code snippets
- embedding images, videos, and surveys
- importing other markdown files