Vanilla Docs

Contributing

If you find any problems in the docs or have a question, open an issue. Please submit edits & additions as pull requests against the appropriate branch.

Once we have sufficient content, we will branch open source release versions. Master branch will reflect vanillaforums.com production.

Organization

The "Features" folder is for all users of Vanilla Forums but descriptions may include services and features specific to the VanillaForums.com hosted service.

The "Developers" folder is for all developers implementing their own code solutions for Vanilla Forums but may include descriptions of solutions that are not possible or disallowed on VanillaForums.com hosted service. Clients of VanillaForums.com should consult support or their sales representative for guidance.

The "Workflow" folder is teams collaborating with Vanilla Forums, Inc. on projects and for those curious about our processes.

Formatting

• Every doc file must end in .html.md and be formatted in Markdown.
• Please use H2 (## in Markdown) as your top-level headings in each file.
• Always use an images folder in the same subfolder as the content referencing it.

Running locally

The following instructions assume that you have already installed Node.js on your computer. If this is not the case, please download and install the latest stable release from the official Node.js download page. If you are using Homebrew, you can also install Node.js via the command line:

$ brew install node

Notice: It is important that you install Node in a way that does not require you to sudo.

Once you have Node.js up and running, you will need to install the local dependencies using npm:

$ npm install

Tasks

The following commands are available to be run from the root of the repository:

Start - npm start

Boots up a local development server and takes care of compiling docs pages, scripts, and stylesheets whenever they change.

Build - npm run build

One-time compilation of docs pages, scripts, and stylesheets. Will also inject Bower-managed dependencies and optimize all output files for deployment.

Deploy - npm run deploy

Similar to npm run build but will also deploy the output files to the gh-pages branch.
‼️ This task can currently only be run by Travis CI.

Clean - npm run clean

Cleans out the temporary and distribution directories created by the above tasks.

---

Copyright © 2014 Vanilla Forums Inc. All rights reserved.