READ THIS

IMPORTANT: This repo is archived. The knowledge base now lives in SalesForce.

There are default examples of both video and document in the repo called video_default.md and document_default.md

Features

• Tutorials organized by category
• Two types of tutorials - text and video
• Ability to have a "tutorial series"
• FAQ section
• Disqus comments
• Sticky sidebar for main headings in tutorials
• RSS/Atom feed
• SEO tags
• Google Analytics

Setup

1. Add your site and author details in _config.yml.
2. Add your Google Analytics, Disqus and MailChimp keys to _config.yml.
3. Get a workflow going to see your site's output (with CloudCannon or Jekyll locally).

Running locally

Once you have this repo checked out,

1. Download and install Docker
2. Start the server and make changes

./bin/run

You can view your changes at : http://localhost:4000 or http://192.168.99.100:4000 (if you're using docker-machine)

to exit, you can do ctrl+c

Livereload

Install the Livereload chrome extension if you like seeing the page auto refresh when making a change.

Editing

Base is already optimized for adding, updating and removing tutorials, navigation, footer and FAQ information in CloudCannon.

The sticky sidebar in tutorials in populated by pulling out <h2> elements from the content.

Posts

• Add, update or remove a post in the Posts collection.
• The tutorials page is organized by categories.
• Change the defaults when new posts are created in _posts/_defaults.md.

Lets break it down a little more

There are two primary posts types, Document and Video.

An important part of the organization of the posts for both documents and videos is the metadata at the top of the file. Breaking down what each field means.

• date: the publishing date, it will not show up to the end user, used for SEO

• title: the title showed at the top of the article and when it's listed

• description: Will not be shown to the user, used for SEO

Example of a category

categories: Are ways to organize similar content

category: Kubernetes

Example of a type

type: Determines what icon is next to your post (Document or Video)

Example of Resources

Resources: Only pertains to "Video" posts. These are the links that appear right below the video

Post Series

To create a new series:

• Add a new document to the sets collection.
• Set the title and description.

To add a tutorial/post to a series:

• Add a set field to the tutorial front matter which points to the file name of the desired set without the .md extension. e.g. If I have a set at _sets/getting-started.md I would use this in my tutorial front matter: set: getting-started.
• Add a set_order field to the tutorial front matter and specify a number. This is the tutorials order in the set.

Navigation

• Exposed as a data file to give clients better access.
• Set in the Data / Navigation section.

Footer

• Exposed as a data file to give clients better access.
• Set in the Data / Footer section.