-
Notifications
You must be signed in to change notification settings - Fork 37
How to: Setup for Contributors
This documentation aim to help people with commit access to both source and generated content
You need a platform supported by jekyll
More information on what is required by jekyll
Clone the repository
$ git clone https://github.com/opencompany/www.opencompany.org
Install the relevant ruby gems
$ cd www.opencompany.org
$ bundle install
The content is generated by jekyll, one way to do it is to serve the content
$ jekyll serve
You can now browse it on http://0.0.0.0:4000
Make sure that you will not override someone else work, by pulling before pushing like so:
$ git pull
If there is conflict, merge, regenerate the content, and push your commit to github.
$ git push
It will be automatically pushed to www.opencompany.org, via github pages.
For convenience, we are using github pages to publish the generated HTML.
Due to a translation workflow issue, we have a separate repository.
The repository used is https://github.com/opencompany/opencompany.github.io
To provide the website in multiple languages, we use a jekyll plugin.
This plugin is not supported by github-pages and will likely be supported in the future.
To workaround the problem, we use travis-ci to take the main repo, generate the content with the multiple language plug-in working and push that content to the repository with github-pages enabled.
This setup is inspired by Hari Menon and described in his blog
The discussion can be found here https://github.com/opencompany/www.opencompany.org/issues/94