TestObject Help Website
CSS HTML Ruby Other

README.md

About this repository

This is the documentation site for TestObject! (http://help.testobject.com)

How to contribute

Fork the repository, read the rest of this README file and make some changes. Once you're done with your changes send a pull request. Thanks!

How to edit the site

Install Ruby:

sudo apt-get update
sudo apt-get install build-essential

wget -O ruby-install-0.6.0.tar.gz \
https://github.com/postmodern/ruby-install/archive/v0.6.0.tar.gz
tar -xzvf ruby-install-0.6.0.tar.gz
cd ruby-install-0.6.0/

sudo make install

To make sure that Ruby is installed:

ruby-install --version

If you want to install it On Mac OS X:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install ruby

Install Bundler:

sudo gem install bundler

Install Jekyll:

sudo gem install jekyll

Clone the project from github:

cd
git clone https://github.com/testobject/help
cd help

Update bundle inside the website directory to install the missing tools:

bundle update

Try to build the project using Jekyll and Bundle:

bundle exec jekyll build

If you get any message about missing files or directories, just go ahead and create the missing directories one by one using "mkdir your/new/folder" and create the missing file using "touch your/path/fileName".

Run Jekyll:

bundle exec jekyll serve

and then open localhost:4000 in your browser.

To regenerate the HTML pages automatically when you make changes to Markdown source files, use:

bundle exec jekyll serve --watch  

This guide has been tested on Linux ubuntu 16.04 LTS version and OS X 10.11.5 .

Broken Links

broken-link-checker can be installed using npm install broken-link-checker -g (sudo may be required).

A check can be run on the live help page with blc http://help.testobject.com -ro.

A check can be run locally by first serving the jekyll site, then running blc http://127.0.0.1:4000 -ro. Note that our current redirect system only redirects when the site is running on Apache. This means that if you are running locally, some links may fail which would pass on production. To solve this, update links in the help page to not rely on redirect.

Redirects

The help page is linked to in many places in product and users may have some pages bookmarked. To avoid 404 errors in these cases, add a redirect when removing a url. This can be done using the alias field in the header.