The following sections explain the various headings of a guide that are required to keep the look and feel consistent.

Your guide will reside in this sfguides/src folder

Please use this markdown file as a template for writing your own Snowflake Guides. This example guide has elements that you will use when writing your own guides, including: code snippet highlighting, downloading files, inserting photos, and more.

Once you complete this guide, you should be able to create your "Snowflake Guide" and submit it using the updated process.

At a minimum, the Guide should include the following headings and subheadings. A single sfguide consists of multiple steps. These steps are defined in Markdown using Header 2 tag ##. Sub-steps will use a Header 3 tag ### and so forth. Please avoid going beyond H4 ####.

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:

REQUIRED FIELDS

OPTIONAL FIELDS

You can see the source metadata at the top of the markdown for this guide here for reference.

This section covers the basic markdown formatting options that you will need for your QuickStart.

Look at the markdown source for this sfguide to see how to use markdown to generate code snippets, info boxes, and download buttons.

Things to Keep in Mind Sticking to these guidelines ensures that all Guides have a similar look and feel. Keeping the document clean helps create a good end-user experience.

Code for adding tables:

Images should:

Code for adding images:

Code for hyperlinking:

Code for adding videos:

All tags are added into the metadata at the start of your markdown file. For fields beyond language, the taxonomy path is added to the "categories" section. Multiple categories are separated by commas.

Language tags are important for the guides to show up in the regional pages. Please use appropriate tags as they align to your guide content.

Select the taxonomy path from the list below and add to the "category" field at the start of your markdown file to specify the content type that the guide will be displayed as on the site. Do not create new content types if you don't see them in the list

Add the "Taxonomy Path" in comma separated format for multiple selections in the "categories: " portion of the header.

Please select any relevant Industries for your Guide and add in the "categories: " section of the header.

You can use the Google Docs feature of saving to Markdown, however please review your markdown before submission as some formatting options can be different. In some instances Google Docs may add additional spacing or characters during conversion that will cause markdown errors.

The process to submit your Guide has been simplified

1. Create a Fork for the main repo and begin writing and formatting your guide (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 and navigate to the folder for your guide or create a new guide.

3. Specific steps to "Create" or "Edit" a Guide are covered in the README file for easy reference

4. The pull request goes through a validation process to ensure the appropriate formatting and tags are used. If any errors are detected, you will be notified of them in a comment on GitHub before you are able to submit the PR.

5. An automated preview link is generated and commented on your PR for you to review and make sure everything looks as expected.

6. The DevRel team will review and approve the PR. Once approved it will publish to www.snowflake.com/en/developers/guides within an hour.

The following automated checks are run and must pass before PRs can be created: