Snowflake-Labs/sfquickstarts

Snowflake-Labs/sfquickstarts

Description: Follow along with our tutorials to get you up and running with Snowflake.

Language: Jupyter Notebook

License: Apache-2.0

Stars: 130

Forks: 1461

Open issues: 560

Created: 2020-09-04T18:25:50Z

Pushed: 2026-06-10T20:40:57Z

Default branch: master

Fork: no

Archived: no

README:

Snowflake Guides

What are Snowflake Guides?

Snowflake Guides serves as a collection of what previously were "Snowflake Quickstarts" and "Snowflake Solutions Center" along with some new additional types of content.

Guides are interactive tutorials and self-serve demos written in markdown syntax. Guides provide a unique step-by-step reading experience and automatically saves tutorial progress for readers. These tutorials are published at: https://www.snowflake.com/en/developers/guides/

You can submit your own Guides to be published on Snowflake's website by submitting a pull request to this repo. This repository contains all the tools and documentation you’ll need for building, writing, and submitting your own Guide.

What You Should Know About Snowflake Guides

• Powerful and flexible authoring flow in Markdown text
• Ability to produce interactive web or markdown tutorials without writing any code
• Easy interactive previewing (using GitHub or Visual Studio Code preview feature)
• Support for anonymous use - ideal for public computers at developer events
• Looks great, with web implementation on snowflake.com
• Anchors to content to make it easy to scroll on a single page

> Please note that the DevRel team has a 24 business hour SLA for approving PRs. Please do not post in #devrel to notify the team of submissions or send DMs unless the 24 hours have passed. Please note there will be delays during US holidays.

Getting Started

Prerequisites

1. A GitHub account 2. [Optional] A code editor (e.g. VS Code) if you choose to publish or make changes through your local environment

Create a New Guide on GitHub.com

1. Fork this repository to your GitHub account (top right of webpage, fork button) > If you have already forked the repository, you can go to your branch and select 'sync fork' to update the repository 2. In your fork, select the 'site' folder on the home page -> Then select the 'sfguides/src' folder. > Ensure you are in your local branch and the path on your page is 'sfquickstarts/site/sfguides/src/'

3. Click "Add file" --> "Create new file" 4. In the "Name your file" field, type your new folder name followed by a "/", then a file name inside it that ends in '.md'. Example: my-guide/my-guide.md

• Please ensure both of the folder name and the markdown file names match exactly (these are case sensitive)

• Please use hyphens, no underscores

• Ensure your folder uses lower case alphabets and "Hyphens (-)" and not "Underscores(_)" in folder name

5. Start authoring in markdown format using the template housed under site -> sfguides/src -> _markdown-template -> markdown-template.md. Select the 'preview' button at the top left to see a preview of your guide.

• Required fields: language, category tags, id, author name, status (leave this as published)

• Optional Fields: summary, environments, feedback link, fork repo link, open in Snowflake

Commit your changes in a branch and name it. Example: Test-demo-branch

6. To submit related assets with your guide, go back to your fork.

• You DO NOT need to request a merge to add additional files.
• In your fork, find your branch you just made in step 5.


• Create an 'assets/' subfolder under your existing guide folder and add a "readme.md" file as a placeholder so the folder is created. GitHub requires a file to be added to a folder to create it.

Example: my-guide/assets/readme.md

• It is recommended not to create further sub-folders within 'assets'

• Please be mindful of image requirements noted here. Image size must be less than 1MB.

• You can add demo files and other .sql files in the "/assets" folder as well if needed.

Separate Repos: Instead of creating separate repos and requesting them to be public, your demo files and content can be placed in "/assets" folder where images are placed. Non image files can now be larger than 1MB as well. > Note: Please review the OSS Policy to ensure you are in accordance with guidelines for demo data. Separate repos created for demos that need to be made public, will need to go through legal reviews outlined in the policy before the request is made to DevRel.

7. Select Commit your changes to the branch (same one you created in Step 5) and click "Compare & pull request" button on the top. 8. On the next page, in the light gray box at the top of the page ensure 'base repository:' is set to 'base: Snowflake-Labs/sfquickstarts'. The 'head repository:' should be set to your fork name and "compare:" should be set to your branch you created in Step 5. Compare your changes made on your branch to the main repository.


9. Update the name and optionally add a description to your request. Create the pull request. > Note: It is recommended to create a draft pull request, run all your checks, then mark as ready for review, so we know it's ready to merge immediately.

Please Note: All PRs have automated checks run against them. The checks assess for the following (please confirm these are met prior to submission): 1. Categories are applied from the approved list

2. ID criteria (second line in template): id must exist, id must be separated by dashes, id must be lowercase, id must match the markdown file name (without .md extension), id must match the immediate folder name the file is in

3. Language tag must be populated (see here for the list)

Submit an Edit to an Existing Guide on GitHub.com

1. Fork this repository to your GitHub account (top right of webpage, fork button) > If you have already forked…