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 has sections and FAQs. The sections are cut-and-dry "here's how to use X". The FAQs are more specific questions that we can answer. Sections and FAQs are separated by a --- in the markdown file.
The directory structure is:
[App Name]/[Section]/[Article].md
for example:
screendoor/responses/importing_responses.md
You'll need node and npm installed.
script/bootstrap- Run the preview server:
wintersmith preview - If you need to run the express-based search indexer:
npm startornodemon search/index.coffee(the latter will monitor for file changes and reload the server automatically)
Run grunt link-checker:dev to check the knowledge base for broken links.
Pushing to the master branch will run the tests and deploy if passing. Changes should always be made in a feature branch and reviewed prior to being merged into master.
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.