The DOBT knowledge base. View the live site

Our users are largely non-technical, so it will be a good source of info for them. Use cases include:

• Using it to run trainings/self-trainings
• Linking to it when we get support requests
• Linking to it from pages inside of our apps
• Using it as a sales tool: sometimes, instead of giving a demo, we can link folks to the appropriate sections in the knowledge base
• SEO

Built with Wintersmith. Hosted on GitHub Pages. Search powered by a small node app running on Heroku.

Each article (page) in the knowledge base will have sections and FAQs. The sections are boring, cut-and-dry "here's how to use X". The FAQs are more specific questions that we can answer. (Our existing support requests will determine what makes it into the FAQs.) Sections and FAQs will be separated by a --- in the markdown file.

The directory structure will be as follows:

[App Name]/[Section]/[Article].md

You'll need node and npm installed.

1. npm install -g coffee-script
2. npm install -g wintersmith
3. npm install
4. wintersmith preview

Pushing to the master branch will automatically run tests (currently just a link-checker) on CircleCI. Pushing to the production branch will run the tests and deploy if passing. Changes should always be made in the master branch (or a feature branch) and reviewed prior to being merged into production. hubot deploy knowledge_base immediately will create and merge a PR from master → production for you.

This codebase, with the exception of the content in the articles/ directory, is MIT licensed. The articles/ are licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.