Standard Directories

ToolTwist has standard directory locations for documentation and testing.

Some of these directories are created automatically in the github repository when you create a new project, but others require setting up after a project repository has been cloned onto your machine. The following command can be used to check the directories exist, and create them as necessary:

curl -s -S -L https://github.com/tooltwist/documentation/raw/master/create-standard-directories.sh | sh

Here's a quick description of the directories:

documentation
   |
   +--> site
   |    This is a special branch of your github repository. Any files created on this branch will get
   |    published as a website, to <username>.github.com/<repository>. Note that after the git push,
   |    it takes several minutes for Github to update the site.
   |
   +--> restapis
   |    Create files in the _posts directory with unique dates then run Publish.sh. The generated API
   |    documentation get copied to github-pages/restapi and published to <username>.github.com/<repositoryName>/restapi. 
   |
   +--> wiki
   |    The files in this directory are a copy of your wiki on the Github site. It is not generally
   |    a good idea to maintain the wiki from here - it's better to use the web interface, but you
   |    can add images here and push them back to github. (Adding images is not possible with the web
   |    interface).

testing
   |
   +--> cucumber
   |      |
   |      +--> features
   |      |    This directory contains tests using cucumber - "features" explained using plain English.
   |      |       |
   |      |       +--> step_definitions
   |      |       |    These are test cases written in Nodejs, that implement the features.