Snowflake QuickStart Guides

quickstarts.snowflake.com.2.mp4

What are Snowflake Quickstarts?

Snowflake Quickstarts are interactive tutorials and self-serve demos written in markdown syntax. Quickstarts provide a unique step-by-step reading experience and automatically saves tutorial progress for readers. These tutorials are published at quickstarts.snowflake.com

You can submit your own Quickstarts 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 Quickstart!

What's special about the Quickstart format?

• Powerful and flexible authoring flow in Markdown text
• Ability to produce interactive web or markdown tutorials without writing any code
• Easy interactive previewing
• Usage monitoring via Google Analytics
• Support for multiple target environments or events (conferences, kiosk, web, offline, etc.)
• Support for anonymous use - ideal for public computers at developer events
• Looks great, with a responsive web implementation
• Remembers where the student left off when returning to a quickstarts
• Mobile friendly user experience

Getting Started

Prerequisites

1. Install Node Version Manager (nvm)
   • Not sure if you have it installed? Run nvm or nvm -v at the command line and hit enter. If you encounter a "command not found" error, you likely do not have it installed.
2. Install Node (required to run the site locally) using nvm: nvm install latest
   • If you have Homebrew installed and don't want to use nvm, run: brew install node
3. Install gulp-cli npm i -g gulp-cli
4. Install Go
   • If you have Homebrew installed, run: brew install golang
   • Install claat go install github.com/googlecodelabs/tools/claat@latest
   • Ensure go and claat is in your PATH claat path setup
5. Optional: install the live-reload plugin for Chrome: LiveReload

Run locally

1. Fork this repository to your personal GitHub account (top right of webpage, fork button)
2. Clone your new fork git clone git@github.com:<YOUR-USERNAME>/sfquickstarts.git sfquickstarts
3. Navigate to the site directory cd sfquickstarts/site
4. Install node dependencies npm install
5. Run the site npm run serve
6. Open a browser to http://localhost:8000/

Congratulations! You now have the Snowflake Quickstarts landing page running.

Common Errors

1. Claat related errors

• Make sure Go is properly in your PATH. Add the following lines to your profile (~/.profile, or ~/.zshrc):

#adding Golang to path
export PATH=$PATH:/usr/local/go/bin
export PATH=$PATH:$HOME/go/bin

Note: After adding Go to your PATH, be sure to apply your new profile: source ~/.profile or source ~/.zshrc

2. You get a EACCES error when installing gulp-cli

• This means that your npm location needs to be updated. Follow the steps here: Resolve EACCESS permissions

3. You get Error: Cannot find module 'postcss' when running npm run serve

• The module may not have been installed for some reason so run npm install --save-dev postcss gulp-postcss and then rerun npm run serve

Write Your First QuickStart

1. Terminate the running server with ctrl C and navigate to the sfguides source directory cd sfguides/src
   • In this directory, you will see all existing guides and their markdown files.
2. Generate a new guide from the guide template npm run template <GUIDE-NAME>
   • Don't use spaces in the name of your guide, instead use hyphens, they are better for SEO.
3. Navigate to the newly generated guide (cd sfguides/src/<GUIDE-NAME>) and edit your guide in a tool like VS Code.
4. Make sure of the following:

• Always check if the first step is labeled Overview AND then make sure there are these specific sections under that step: 1) Overview, 2) What You Will Build, 3) What You Will Learn, 4) Prerequisites
• Always check if the last step is labeled Conclusion and Resources and then make sure it includes these specific sections **1) Conclusion, 2) What You Learned, and 3) Resources (with links to docs, blogs, videos, etc.)

5. Run the website again npm run serve and verify all of the line items in step 4 AND...

• Make sure there are no errors -- these are usually related to someone forgetting to include an image or if the filename is incorrect
• Browse to localhost:8000 and see if 1) the site loads, and 2) you can visually see the new OR updated QS on the locally served site. If you don't see the QS, it could be because: 1) the status at the very top is set to Hidden -- which in some cases is deliberate (let us know if that's the case), and/or 2) there's a comment or a blank line in the metadata attributes at the top--if there is, delete it. In either case, check and re-run, or reach out to us to help debug
• Assuming the QS is accessible, click on the QS
• Make sure all the publicly accessible links work

If you see any issues or any inconsistencies as outlined above, please do NOT create/submit the PR before you resolve those items.

Here are three QS Guides you can take a look as references:

• https://quickstarts.snowflake.com/guide/getting_started_with_dataengineering_ml_using_snowpark_python/index.html#0
• https://quickstarts.snowflake.com/guide/getting_started_with_snowflake_arctic/index.html#0
• https://quickstarts.snowflake.com/guide/build_genai_inpainting_and_hybridtable_app_in_snowpark_container_services/index.html?index=..%2F..index#0

We want to maintain a standard and consistency across all QS guides and it's very imp that we all follow these guidelines. Really appreciate your help and support.

Other Tips

• You can see the supported Quickstart categories here. If you want to suggest a new category please create a GitHub issue.
• Checkout how to use VS Code to write markdown files
• If you want to learn more about Quickstarts, check out this excellent tutorial

How do I get my Snowflake QuickStart on quickstarts.snowflake.com?

Proceed ONLY if you have followed the quidelines outlined in Write Your First Quickstart.

1. You will need to sign Snowflake's CLA. The action required on your part is to specify in your (first) pull request comment that you accept it.
2. Fork this repository
3. Clone it to your local machine
4. Make your changes/edits/updates on your locally cloned repo
5. Run the site locally again via npm run serve and make sure you have followed the quidelines outlined in Write Your First Quickstart
6. Push the changes/edits/updates back to your repo
7. Open this repository on github.com
8. Click the Pull Request button to open a new pull request ONLY if you have followed the quidelines outlined in Write Your First Quickstart
9. Snowflake will review and approve the submission

To learn more about how to submit a pull request on GitHub in general, check out GitHub's official documentation.

Reporting issues or errata in Quickstarts

Quickstarts are not in the scope of Snowflake Global Support. Please do not file support cases for issues or errata in a Quickstart. If you encounter an issue in a Quickstart (outdated copy or data, typos, broken links, etc.), please file an issue in this repository. Be sure to include the following information:

1. The title of the Quickstart
2. A link to the Quickstart
3. A description of the problem
4. A proposed solution, if applicable (optional)