https://github.com/Snowflake-Labs/sfquickstarts/assets/2223194/a9f57881-ccf0-4549-89d6-d2fe2569012a
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!
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.nvm install latest
brew install node
npm i -g gulp-cli
brew install golang
go install github.com/googlecodelabs/tools/claat@latest
PATH
claat path setupfork
button)git clone git@github.com:<YOUR-USERNAME>/sfquickstarts.git sfquickstarts
cd sfquickstarts/site
npm install
npm run serve
Congratulations! You now have the Snowflake Quickstarts landing page running.
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
EACCES
error when installing gulp-cli
Error: Cannot find module 'postcss'
when running npm run serve
npm install --save-dev postcss gulp-postcss
and then rerun npm run serve
ctrl C
and navigate to the sfguides
source directory cd sfguides/src
npm run template <GUIDE-NAME>
cd sfguides/src/<GUIDE-NAME>
) and edit your guide in a tool like VS Code.npm run serve
and verify all of the line items in step 4 AND...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 debugIf 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:
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.
Proceed ONLY if you have followed the quidelines outlined in Write Your First Quickstart.
npm run serve
and make sure you have followed the quidelines outlined in Write Your First QuickstartTo learn more about how to submit a pull request on GitHub in general, check out GitHub's official documentation.
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: