Instructions for Contributing to the Docs/Website
- Fork this repository
- Deploy the site locally
- Add your changes
- Create Pull Request
Deployment of the site locally
The below commands setup your environment for running GitHub pages locally. Any edits you make will be viewable on a lightweight webserver that runs on your local machine.
Install Ruby 2.2 or higher. If you're on Linux, run these commands:
sudo apt-get install software-properties-common
sudo apt-add-repository ppa:brightbox/ruby-ng
sudo apt-get update
sudo apt-get install ruby2.2
sudo apt-get install ruby2.2-dev
- If you're on a Mac, follow these instructions.
- If you're on a Windows machine you can use the Ruby Installer. During the installation make sure to check the option for Add Ruby executables to your PATH.
Install the GitHub Pages package, which includes Jekyll:
gem install github-pages
Clone our site:
git clone https://github.com/thingsboard/thingsboard.github.io.git
Make any changes you want. Then, to see your changes locally:
cd thingsboard.github.io
bundle exec jekyll serve
Your copy of the site will then be viewable at: http://localhost:4000 (or wherever Jekyll tells you).